openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/RPY_BMFI_READ_LOCK_31:
    post:
      tags:
      - SIBM
      summary: Read filter with contents locking
      operationId: /rfc/RPY_BMFI_READ_LOCK_31
      requestBody:
        content:
          application/json:
            schema:
              properties:
                CICO_REQUEST_NO:
                  type: string
                  maxLength: 10
                  description: Number of Check-In-Check-Out-Request
                LANGUAGE:
                  type: string
                  default: SY-LANGU
                  maxLength: 1
                  description: Language of objects to read
                OBJECT_ID:
                  type: string
                  maxLength: 10
                  description: Filter ID
                ACTION_LOG:
                  type: array
                  items:
                    type: object
                    properties:
                      CLUST_D:
                        type: string
                        maxLength: 255
                        description: Char255
                ERRORS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJECTID:
                        type: string
                        maxLength: 30
                        description: Object name
                      OBJECTTYPE:
                        type: string
                        maxLength: 4
                        description: Object Type
                      MSGID:
                        type: string
                        maxLength: 2
                        description: Message ID
                      MSGTYPE:
                        type: string
                        maxLength: 1
                        description: Message Type
                      MSGNUMBER:
                        type: integer
                        format: int64
                        description: Message Number
                      MSGVAR1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MSGVAR2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MSGVAR3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MSGVAR4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      ERRORCLASS:
                        type: string
                        maxLength: 10
                        description: 'Error class repository API  enumValues: ERR_AUTH=Authorization error,ERR_INT=Internal error,ERR_TRLOCK=Long-term lock on object,ERR_CONSIS=Object is inconsistent,ERR_LANGU=Object has other master language,ERR_PARAM=Function module incorrectly parameterized,ERR_ENQ=Temporary lock on object,ERR_EXIST=Object does not exist,ERR_DOUBLE=Object already exists'
                        enum:
                        - ERR_AUTH
                        - ERR_INT
                        - ERR_TRLOCK
                        - ERR_CONSIS
                        - ERR_LANGU
                        - ERR_PARAM
                        - ERR_ENQ
                        - ERR_EXIST
                        - ERR_DOUBLE
                VARIANTS:
                  type: array
                  items:
                    type: object
                    properties:
                      VARIANT_ID:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      LANGU:
                        type: string
                        maxLength: 1
                        description: Language Key
                      NAME:
                        type: string
                        maxLength: 100
                        description: Name
                      INHERITED:
                        type: string
                        maxLength: 1
                        description: 'Text imparted by predecessor variant  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      FSTUSER:
                        type: string
                        maxLength: 12
                        description: Created by
                      FSTDATE:
                        type: string
                        format: date
                        description: Date on which the record was created
                      FSTTIME:
                        type: string
                        maxLength: 6
                        description: Creation Time
                      LSTUSER:
                        type: string
                        maxLength: 12
                        description: Changed by
                      LSTDATE:
                        type: string
                        format: date
                        description: Changed on
                      LSTTIME:
                        type: string
                        maxLength: 6
                        description: Last changed at
                      FSTREL:
                        type: string
                        maxLength: 4
                        description: First Release
                      IDENT:
                        type: string
                        maxLength: 32
                        description: GUID (Global Unique Identifier)
                      COMP_OBJ:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      COMP_TYP:
                        type: string
                        maxLength: 4
                        description: Object Type
                      PRED_FIL:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      PRED_SEL:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      VARI_TYPE:
                        type: string
                        maxLength: 2
                        description: 'Variant type  enumValues: FV=Function Variant,SV=Scenario Variant,IV=Integration Model Variant,PV=Process Variant'
                        enum:
                        - FV
                        - SV
                        - IV
                        - PV
                      CONTXTTP:
                        type: string
                        maxLength: 4
                        description: 'Context type of a variant  enumValues: '' ''=Variant is defined globally for the filter,NODE=Variant is defined locally for a node of a variant'
                        enum:
                        - ''' '''
                        - NODE
                      CONTXTID:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                VARIANT_CONTENTS:
                  type: array
                  items:
                    type: object
                    properties:
                      VARIANT_ID:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      ITEM_TYPE:
                        type: string
                        maxLength: 2
                        description: 'Item type  enumValues: OE=Output entity,SB=System OrgUnit (BOR object),SE=System OrgUnit (entity),EN=Node number in EPC,IE=Input entity'
                        enum:
                        - OE
                        - SB
                        - SE
                        - EN
                        - IE
                      ITEM_ID:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      SELECTED:
                        type: string
                        maxLength: 1
                        description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      OPTN:
                        type: string
                        maxLength: 1
                        description: 'Functional use: optional function  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      DEFAULTVAL:
                        type: string
                        maxLength: 1
                        description: 'Default values  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      INITIALVAL:
                        type: string
                        maxLength: 1
                        description: 'Initial  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      PROTECTED:
                        type: string
                        maxLength: 1
                        description: 'Protected  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                VARIANT_CONTEXTS:
                  type: array
                  items:
                    type: object
                    properties:
                      VARIANT_ID:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      CONTXT_VAR:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      CONTXT_NOD:
                        type: string
                        maxLength: 10
                        description: Context node
                      SELECTED:
                        type: string
                        maxLength: 1
                        description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      DEFAULTVAL:
                        type: string
                        maxLength: 1
                        description: 'Default values  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      INITIALVAL:
                        type: string
                        maxLength: 1
                        description: 'Initial  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      PROTECTED:
                        type: string
                        maxLength: 1
                        description: 'Protected  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
              required:
              - CICO_REQUEST_NO
              - OBJECT_ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  ERROR_OCCURED:
                    type: string
                    maxLength: 1
                    description: Error occured, error table has entries
                  FILTER_HEADER:
                    type: object
                    properties:
                      FILTER_ID:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      LANGU:
                        type: string
                        maxLength: 1
                        description: Language Key
                      NAME:
                        type: string
                        maxLength: 100
                        description: Name
                      FSTUSER:
                        type: string
                        maxLength: 12
                        description: Created by
                      FSTDATE:
                        type: string
                        format: date
                        description: Date on which the record was created
                      FSTTIME:
                        type: string
                        maxLength: 6
                        description: Creation Time
                      LSTUSER:
                        type: string
                        maxLength: 12
                        description: Changed by
                      LSTDATE:
                        type: string
                        format: date
                        description: Changed on
                      LSTTIME:
                        type: string
                        maxLength: 6
                        description: Last changed at
                      FSTREL:
                        type: string
                        maxLength: 4
                        description: First Release
                      FILTER_TYP:
                        type: string
                        maxLength: 1
                        description: 'Filter type  enumValues: X=Can choose protected node,""=Cannot choose protected node'
                        enum:
                        - X
                        - ''
                      DEVCLASS:
                        type: string
                        maxLength: 4
                        description: Not More Closely Defined Area, Possibly Used for Patchlevels
                      ORIGINAL:
                        type: string
                        maxLength: 10
                        description: 10 figure 3.0/3.1 ID for Business Navigator objects
                      CLIENT:
                        type: string
                        maxLength: 3
                        description: Client
                      IDENT:
                        type: string
                        maxLength: 32
                        description: GUID (Global Unique Identifier)
                  PROCESSING_STATUS:
                    type: string
                    maxLength: 2
                    description: Status of processing
                  ACTION_LOG:
                    type: array
                    items:
                      type: object
                      properties:
                        CLUST_D:
                          type: string
                          maxLength: 255
                          description: Char255
                  ERRORS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJECTID:
                          type: string
                          maxLength: 30
                          description: Object name
                        OBJECTTYPE:
                          type: string
                          maxLength: 4
                          description: Object Type
                        MSGID:
                          type: string
                          maxLength: 2
                          description: Message ID
                        MSGTYPE:
                          type: string
                          maxLength: 1
                          description: Message Type
                        MSGNUMBER:
                          type: integer
                          format: int64
                          description: Message Number
                        MSGVAR1:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MSGVAR2:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MSGVAR3:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MSGVAR4:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        ERRORCLASS:
                          type: string
                          maxLength: 10
                          description: 'Error class repository API  enumValues: ERR_AUTH=Authorization error,ERR_INT=Internal error,ERR_TRLOCK=Long-term lock on object,ERR_CONSIS=Object is inconsistent,ERR_LANGU=Object has other master language,ERR_PARAM=Function module incorrectly parameterized,ERR_ENQ=Temporary lock on object,ERR_EXIST=Object does not exist,ERR_DOUBLE=Object already exists'
                          enum:
                          - ERR_AUTH
                          - ERR_INT
                          - ERR_TRLOCK
                          - ERR_CONSIS
                          - ERR_LANGU
                          - ERR_PARAM
                          - ERR_ENQ
                          - ERR_EXIST
                          - ERR_DOUBLE
                  VARIANTS:
                    type: array
                    items:
                      type: object
                      properties:
                        VARIANT_ID:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        LANGU:
                          type: string
                          maxLength: 1
                          description: Language Key
                        NAME:
                          type: string
                          maxLength: 100
                          description: Name
                        INHERITED:
                          type: string
                          maxLength: 1
                          description: 'Text imparted by predecessor variant  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        FSTUSER:
                          type: string
                          maxLength: 12
                          description: Created by
                        FSTDATE:
                          type: string
                          format: date
                          description: Date on which the record was created
                        FSTTIME:
                          type: string
                          maxLength: 6
                          description: Creation Time
                        LSTUSER:
                          type: string
                          maxLength: 12
                          description: Changed by
                        LSTDATE:
                          type: string
                          format: date
                          description: Changed on
                        LSTTIME:
                          type: string
                          maxLength: 6
                          description: Last changed at
                        FSTREL:
                          type: string
                          maxLength: 4
                          description: First Release
                        IDENT:
                          type: string
                          maxLength: 32
                          description: GUID (Global Unique Identifier)
                        COMP_OBJ:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        COMP_TYP:
                          type: string
                          maxLength: 4
                          description: Object Type
                        PRED_FIL:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        PRED_SEL:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        VARI_TYPE:
                          type: string
                          maxLength: 2
                          description: 'Variant type  enumValues: FV=Function Variant,SV=Scenario Variant,IV=Integration Model Variant,PV=Process Variant'
                          enum:
                          - FV
                          - SV
                          - IV
                          - PV
                        CONTXTTP:
                          type: string
                          maxLength: 4
                          description: 'Context type of a variant  enumValues: '' ''=Variant is defined globally for the filter,NODE=Variant is defined locally for a node of a variant'
                          enum:
                          - ''' '''
                          - NODE
                        CONTXTID:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                  VARIANT_CONTENTS:
                    type: array
                    items:
                      type: object
                      properties:
                        VARIANT_ID:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        ITEM_TYPE:
                          type: string
                          maxLength: 2
                          description: 'Item type  enumValues: OE=Output entity,SB=System OrgUnit (BOR object),SE=System OrgUnit (entity),EN=Node number in EPC,IE=Input entity'
                          enum:
                          - OE
                          - SB
                          - SE
                          - EN
                          - IE
                        ITEM_ID:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        SELECTED:
                          type: string
                          maxLength: 1
                          description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        OPTN:
                          type: string
                          maxLength: 1
                          description: 'Functional use: optional function  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        DEFAULTVAL:
                          type: string
                          maxLength: 1
                          description: 'Default values  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        INITIALVAL:
                          type: string
                          maxLength: 1
                          description: 'Initial  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        PROTECTED:
                          type: string
                          maxLength: 1
                          description: 'Protected  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                  VARIANT_CONTEXTS:
                    type: array
                    items:
                      type: object
                      properties:
                        VARIANT_ID:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        CONTXT_VAR:
                          type: string
                          maxLength: 10
                          description: 10 figure 3.0/3.1 ID for Business Navigator objects
                        CONTXT_NOD:
                          type: string
                          maxLength: 10
                          description: Context node
                        SELECTED:
                          type: string
                          maxLength: 1
                          description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        DEFAULTVAL:
                          type: string
                          maxLength: 1
                          description: 'Default values  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        INITIALVAL:
                          type: string
                          maxLength: 1
                          description: 'Initial  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        PROTECTED:
                          type: string
                          maxLength: 1
                          description: 'Protected  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
