openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/SKWF_INDEX_COMBINED_SEARCH_XML:
    post:
      tags:
      - SKWF_RETRIEVAL
      operationId: /rfc/SKWF_INDEX_COMBINED_SEARCH_XML
      requestBody:
        content:
          application/json:
            schema:
              properties:
                CONNECTION_SPACE:
                  type: string
                  maxLength: 30
                  description: Class connection space
                CONTEXT_ID:
                  type: string
                  maxLength: 32
                  description: 'KW Framework: Context ID'
                LANGUAGE:
                  type: string
                  default: SY-LANGU
                  maxLength: 1
                  description: Language
                NUMBER_OF_FEATURES:
                  type: integer
                  format: int64
                  default: 10
                PTYPE:
                  type: integer
                  format: int64
                RESULT_FROM:
                  type: integer
                  format: int64
                  default: 1
                RESULT_TO:
                  type: integer
                  format: int64
                  default: 100
                X_STRICT:
                  type: string
                  maxLength: 1
                ATTRIBUTE_QUERIES:
                  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
                FEATURES_RESULT:
                  type: array
                  items:
                    type: object
                    properties:
                      PH_CLASS:
                        type: string
                        maxLength: 10
                        description: Physical document class
                      PHIO_ID:
                        type: string
                        maxLength: 32
                        description: Physical document
                      FEATURE:
                        type: string
                        maxLength: 1022
                        description: Text data stream (line)
                      MULTICNT:
                        type: integer
                        format: int64
                        description: Multi-document Attribute Counter
                FOLDERS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJTYPE:
                        type: string
                        maxLength: 1
                        description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                        enum:
                        - R
                        - L
                        - P
                        - ''
                        - F
                      CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      OBJID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                PHIO_CLASSES:
                  type: array
                  items:
                    type: object
                    properties:
                      CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                PROPERTIES_REQUEST:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        maxLength: 25
                        description: Attribute of a document or a relationship
                PROPERTIES_RESULT:
                  type: array
                  items:
                    type: object
                    properties:
                      CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      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
                RESULT_LOIOS_PHIOS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJTYPEP:
                        type: string
                        maxLength: 1
                        description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                        enum:
                        - R
                        - L
                        - P
                        - ''
                        - F
                      CLASSP:
                        type: string
                        maxLength: 10
                        description: Document class
                      OBJIDP:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      OBJTYPEL:
                        type: string
                        maxLength: 1
                        description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                        enum:
                        - R
                        - L
                        - P
                        - ''
                        - F
                      CLASSL:
                        type: string
                        maxLength: 10
                        description: Document class
                      OBJIDL:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      RANKV:
                        type: integer
                        format: int64
                        description: Rank in the hit list
                      DOCREFER:
                        type: integer
                        format: int64
                        description: Reference of a Document Attribute to a Document
                XML_QUERIES:
                  type: array
                  items:
                    type: object
                    properties:
                      XMLQUERY:
                        type: string
                        maxLength: 255
                        description: Value of an attribute, term or operator in the search
              required:
              - CONNECTION_SPACE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  ERROR:
                    type: object
                    properties:
                      ID:
                        type: string
                        maxLength: 20
                        description: Message Class
                      TYPE:
                        type: string
                        maxLength: 1
                        description: Message Type
                      'NO':
                        type: integer
                        format: int64
                        description: Message Number
                      V1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                  KIND_OF_SEARCH:
                    type: string
                    maxLength: 1
                    description: Type of search
                  LAST_SEARCH_LIMIT:
                    type: integer
                    format: int64
                  NUM_OF_HITS:
                    type: integer
                    format: int64
                    description: No. documents found
                  RCODE:
                    type: string
                    maxLength: 4
                  ATTRIBUTE_QUERIES:
                    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
                  FEATURES_RESULT:
                    type: array
                    items:
                      type: object
                      properties:
                        PH_CLASS:
                          type: string
                          maxLength: 10
                          description: Physical document class
                        PHIO_ID:
                          type: string
                          maxLength: 32
                          description: Physical document
                        FEATURE:
                          type: string
                          maxLength: 1022
                          description: Text data stream (line)
                        MULTICNT:
                          type: integer
                          format: int64
                          description: Multi-document Attribute Counter
                  FOLDERS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJTYPE:
                          type: string
                          maxLength: 1
                          description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                          enum:
                          - R
                          - L
                          - P
                          - ''
                          - F
                        CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        OBJID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                  PHIO_CLASSES:
                    type: array
                    items:
                      type: object
                      properties:
                        CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                  PROPERTIES_REQUEST:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 25
                          description: Attribute of a document or a relationship
                  PROPERTIES_RESULT:
                    type: array
                    items:
                      type: object
                      properties:
                        CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        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
                  RESULT_LOIOS_PHIOS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJTYPEP:
                          type: string
                          maxLength: 1
                          description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                          enum:
                          - R
                          - L
                          - P
                          - ''
                          - F
                        CLASSP:
                          type: string
                          maxLength: 10
                          description: Document class
                        OBJIDP:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        OBJTYPEL:
                          type: string
                          maxLength: 1
                          description: 'KW Framework: IO type  enumValues: R=Relationship,L=LOIO,P=PHIO,""=Undefined (= all),F=Directory'
                          enum:
                          - R
                          - L
                          - P
                          - ''
                          - F
                        CLASSL:
                          type: string
                          maxLength: 10
                          description: Document class
                        OBJIDL:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        RANKV:
                          type: integer
                          format: int64
                          description: Rank in the hit list
                        DOCREFER:
                          type: integer
                          format: int64
                          description: Reference of a Document Attribute to a Document
                  XML_QUERIES:
                    type: array
                    items:
                      type: object
                      properties:
                        XMLQUERY:
                          type: string
                          maxLength: 255
                          description: Value of an attribute, term or operator in the search
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
