openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/SKWF_SIMILAR_DOCS_SEARCH:
    post:
      tags:
      - SKWF_RETRIEVAL
      operationId: /rfc/SKWF_SIMILAR_DOCS_SEARCH
      requestBody:
        content:
          application/json:
            schema:
              properties:
                CONNECTION_SPACE:
                  type: string
                  maxLength: 30
                  description: 'Model: Entity Name'
                CONTEXT_ID:
                  type: string
                  maxLength: 32
                  description: 'KW Framework: Context ID'
                LANGUAGE:
                  type: string
                  default: SY-LANGU
                  maxLength: 1
                  description: SAP R/3 System, Current Language
                PTYPE:
                  type: integer
                  format: int64
                  description: 'KW Framework: Storage Type of Attribute'
                RESULT_FROM:
                  type: integer
                  format: int64
                  default: 1
                  description: SAP R/3 System, Current Language
                RESULT_TO:
                  type: integer
                  format: int64
                  default: 10
                  description: SAP R/3 System, Current Language
                X_STRICT:
                  type: string
                  maxLength: 1
                  description: 'KW Framework: Boolean Flag (''X'' Set, '' '' Deleted)'
                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
                PHIOS:
                  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
                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
                SIMILAR_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
              required:
              - CONNECTION_SPACE
              - RESULT_FROM
              - RESULT_TO
      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
                  LAST_SEARCH_LIMIT:
                    type: integer
                    format: int64
                  NUM_SIMILAR_DOCS:
                    type: integer
                    format: int64
                  RCODE:
                    type: string
                    maxLength: 4
                    description: Error Number
                  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
                  PHIOS:
                    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
                  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
                  SIMILAR_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
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
