openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/BDS_BUSINESSDOCUMENT_QUERY_R:
    post:
      tags:
      - BDS_BAPI
      operationId: /rfc/BDS_BUSINESSDOCUMENT_QUERY_R
      requestBody:
        content:
          application/json:
            schema:
              properties:
                CLASSNAME:
                  type: string
                  maxLength: 30
                CLASSTYPE:
                  type: string
                  maxLength: 2
                CLIENT:
                  type: string
                  default: SY-MANDT
                  maxLength: 3
                DOC_ID:
                  type: string
                  maxLength: 42
                  description: 'Business Document Service: Document ID'
                DOC_VAR_ID:
                  type: integer
                  format: int64
                  description: 'Business Document Service: Document variant ID'
                DOC_VER_NO:
                  type: integer
                  format: int64
                  description: 'Business Document Service: Document version number'
                LOGICAL_SYSTEM:
                  type: string
                  maxLength: 10
                OBJECT_KEY:
                  type: string
                  maxLength: 70
                PROPERTIES:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      NAME:
                        type: string
                        maxLength: 25
                        description: Attribute of a document or a relationship
                      VALUE:
                        type: string
                        maxLength: 64
                        description: Attribute Value
                QUERY:
                  type: array
                  items:
                    type: object
                    properties:
                      PROP_NAME:
                        type: string
                        maxLength: 25
                        description: Attribute of a document or a relationship
                      SIGN:
                        type: string
                        maxLength: 1
                        description: 'Include-exclude attribute in search query  enumValues: E=Exclusive no.,I=Inclusive no.'
                        enum:
                        - E
                        - I
                      OPTION:
                        type: string
                        maxLength: 2
                        description: 'Relational operator in search query  enumValues: NE=Not equal to,CP=Contains template ...,LT=Less than,GT=Greater than,LE=Less than or equal to,EQ=Equal to,BT=Between ... and ...,NP=Contains no template ...,GE=Greater than or equal to,NB=Not between ... and ...'
                        enum:
                        - NE
                        - CP
                        - LT
                        - GT
                        - LE
                        - EQ
                        - BT
                        - NP
                        - GE
                        - NB
                      LOW:
                        type: string
                        maxLength: 64
                        description: Lower interval limit for search query
                      HIGH:
                        type: string
                        maxLength: 64
                        description: Upper interval limit for search query
                RELATIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_ID:
                        type: string
                        maxLength: 42
                        description: 'Business Document Service: Document ID'
                      DOC_VER_NO:
                        type: integer
                        format: int64
                        description: 'Business Document Service: Document version number'
                      DOC_VAR_ID:
                        type: integer
                        format: int64
                        description: 'Business Document Service: Document variant ID'
                      DOC_VAR_TG:
                        type: string
                        maxLength: 2
                        description: 'Business Document Service: Document Variant Tag'
                      RELA_ID:
                        type: string
                        maxLength: 32
                        description: 'Business Document Service: Relationship ID'
                      REL_DOC_ID:
                        type: string
                        maxLength: 42
                        description: 'Business Document Service: Document ID'
                SIGNATURE:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_COUNT:
                        type: integer
                        format: int64
                        description: 'Business Document Service: Document counter'
                      DOC_ID:
                        type: string
                        maxLength: 42
                        description: 'Business Document Service: Document ID'
                      DOC_VER_NO:
                        type: integer
                        format: int64
                        description: 'Business Document Service: Document version number'
                      DOC_VAR_ID:
                        type: integer
                        format: int64
                        description: 'Business Document Service: Document variant ID'
                      DOC_VAR_TG:
                        type: string
                        maxLength: 2
                        description: 'Business Document Service: Document Variant Tag'
                      COMP_COUNT:
                        type: integer
                        format: int64
                        description: 'Business Document Service: Number of components'
                      PROP_NAME:
                        type: string
                        maxLength: 25
                        description: 'Business Document Service: Attribute Name'
                      PROP_VALUE:
                        type: string
                        maxLength: 64
                        description: 'Business Document Service: Attribute value'
              required:
              - CLASSNAME
              - CLASSTYPE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  PROPERTIES:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        NAME:
                          type: string
                          maxLength: 25
                          description: Attribute of a document or a relationship
                        VALUE:
                          type: string
                          maxLength: 64
                          description: Attribute Value
                  QUERY:
                    type: array
                    items:
                      type: object
                      properties:
                        PROP_NAME:
                          type: string
                          maxLength: 25
                          description: Attribute of a document or a relationship
                        SIGN:
                          type: string
                          maxLength: 1
                          description: 'Include-exclude attribute in search query  enumValues: E=Exclusive no.,I=Inclusive no.'
                          enum:
                          - E
                          - I
                        OPTION:
                          type: string
                          maxLength: 2
                          description: 'Relational operator in search query  enumValues: NE=Not equal to,CP=Contains template ...,LT=Less than,GT=Greater than,LE=Less than or equal to,EQ=Equal to,BT=Between ... and ...,NP=Contains no template ...,GE=Greater than or equal to,NB=Not between ... and ...'
                          enum:
                          - NE
                          - CP
                          - LT
                          - GT
                          - LE
                          - EQ
                          - BT
                          - NP
                          - GE
                          - NB
                        LOW:
                          type: string
                          maxLength: 64
                          description: Lower interval limit for search query
                        HIGH:
                          type: string
                          maxLength: 64
                          description: Upper interval limit for search query
                  RELATIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_ID:
                          type: string
                          maxLength: 42
                          description: 'Business Document Service: Document ID'
                        DOC_VER_NO:
                          type: integer
                          format: int64
                          description: 'Business Document Service: Document version number'
                        DOC_VAR_ID:
                          type: integer
                          format: int64
                          description: 'Business Document Service: Document variant ID'
                        DOC_VAR_TG:
                          type: string
                          maxLength: 2
                          description: 'Business Document Service: Document Variant Tag'
                        RELA_ID:
                          type: string
                          maxLength: 32
                          description: 'Business Document Service: Relationship ID'
                        REL_DOC_ID:
                          type: string
                          maxLength: 42
                          description: 'Business Document Service: Document ID'
                  SIGNATURE:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_COUNT:
                          type: integer
                          format: int64
                          description: 'Business Document Service: Document counter'
                        DOC_ID:
                          type: string
                          maxLength: 42
                          description: 'Business Document Service: Document ID'
                        DOC_VER_NO:
                          type: integer
                          format: int64
                          description: 'Business Document Service: Document version number'
                        DOC_VAR_ID:
                          type: integer
                          format: int64
                          description: 'Business Document Service: Document variant ID'
                        DOC_VAR_TG:
                          type: string
                          maxLength: 2
                          description: 'Business Document Service: Document Variant Tag'
                        COMP_COUNT:
                          type: integer
                          format: int64
                          description: 'Business Document Service: Number of components'
                        PROP_NAME:
                          type: string
                          maxLength: 25
                          description: 'Business Document Service: Attribute Name'
                        PROP_VALUE:
                          type: string
                          maxLength: 64
                          description: 'Business Document Service: Attribute value'
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
