openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/SEFS_EXECUTE_SEARCH:
    post:
      tags:
      - SEFS_API_SERVICE_PROVIDER
      summary: Execute Search API
      operationId: /rfc/SEFS_EXECUTE_SEARCH
      requestBody:
        content:
          application/json:
            schema:
              properties:
                IT_ATTR_DIST_DEFINITION:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        maxLength: 64
                        description: Attribute name
                      BROWSING_REL:
                        type: integer
                        format: int32
                        description: Relevance for using this attribute for browsing, default 100
                      CLUSTER_SIZE:
                        type: integer
                        format: int32
                        description: Default cluster size
                      ALGORITHM:
                        type: string
                        maxLength: 20
                        description: Algorithm
                      GROUPING_RANGE:
                        type: string
                        description: Grouping range, eg. l1[0-100],l1[100-200]
                IT_OBJ_TYPE_IDS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJECT_TYPE_ID:
                        type: string
                        maxLength: 255
                        description: Object type within a search service provider
                IT_QUERY:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTRIBUTE_NAME:
                        type: string
                        description: Attribute name
                      ATTRIBUTE_TYPE:
                        type: string
                        maxLength: 1
                        description: Attribute type
                      VALUE1:
                        type: string
                        description: from
                      VALUE2:
                        type: string
                        description: to (only for between search)
                      ROWTYPE:
                        type: string
                        maxLength: 15
                        description: Rowtype (TERM, OPERATOR, ATTRIBUTE,...)
                      OPERATOR:
                        type: string
                        maxLength: 2
                        description: Operator (EQ, BT, ...)
                      CONTENT_TYPE:
                        type: string
                        maxLength: 1
                        description: Content type
                      TERM_ACTION:
                        type: string
                        maxLength: 1
                        description: Term action (Exact, fuzzy, linquistic search)
                      FUZZY_SIMILARITY:
                        type: integer
                        format: int32
                        description: 'fuzzy search: similarity 0..10000'
                IT_REQUESTED_FIELDS:
                  type: array
                  items:
                    type: string
                    description: Attribute name
                IT_SORT:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTRIBUTE_NAME:
                        type: string
                        description: Attribute name
                      SORT:
                        type: string
                        maxLength: 1
                        description: Sort direction of result list (1 = ascending;  0 = desc.)
                IV_ATTR_DIST_GLOBAL:
                  type: object
                  properties:
                    RETURN_ATTR_DIST:
                      type: string
                      maxLength: 1
                      description: 'Do return the attribute distribution from the search engine  enumValues: X=TRUE,""=FALSE'
                      enum:
                      - X
                      - ''
                    MAX_NUM_ATTRIBUTES:
                      type: integer
                      format: int32
                      description: Maximum number of attributes for returning distribution
                    OPT_NUM_VALUES:
                      type: integer
                      format: int32
                      description: Optimal number of values
                    MAX_NUM_VALUES:
                      type: integer
                      format: int32
                      description: Maxiumum number of return values
                IV_FROM:
                  type: integer
                  format: int32
                  default: 1
                  description: Language according to ISO 639
                IV_LANGU:
                  type: string
                  maxLength: 2
                  description: Language according to ISO 639
                IV_TO:
                  type: integer
                  format: int32
                  default: 5
                  description: Language according to ISO 639
                IV_USER_NAME:
                  type: string
                  maxLength: 12
                  description: User Names
              required:
              - IT_OBJ_TYPE_IDS
              - IT_QUERY
              - IV_FROM
              - IV_TO
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  ES_ERROR_RETURN:
                    type: object
                    properties:
                      TYPE:
                        type: string
                        maxLength: 1
                        description: 'Message type: S Success, E Error, W Warning, I Info, A Abort'
                      ID:
                        type: string
                        maxLength: 20
                        description: Message Class
                      NUMBER:
                        type: integer
                        format: int64
                        description: Message Number
                      MESSAGE:
                        type: string
                        maxLength: 220
                        description: Message Text
                      LOG_NO:
                        type: string
                        maxLength: 20
                        description: 'Application log: log number'
                      LOG_MSG_NO:
                        type: integer
                        format: int64
                        description: 'Application log: Internal message serial number'
                      MESSAGE_V1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MESSAGE_V2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MESSAGE_V3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MESSAGE_V4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      PARAMETER:
                        type: string
                        maxLength: 32
                        description: Parameter Name
                      ROW:
                        type: integer
                        format: int32
                        description: Lines in parameter
                      FIELD:
                        type: string
                        maxLength: 30
                        description: Field in parameter
                      SYSTEM:
                        type: string
                        maxLength: 10
                        description: Logical system from which message originates
                  ET_ATTR_DIST_RANGES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          maxLength: 64
                          description: Attribute name
                        GROUPNAMEFROM:
                          type: string
                          maxLength: 128
                          description: From
                        GROUPNAMETO:
                          type: string
                          maxLength: 128
                          description: To
                        OPERATOR:
                          type: string
                          maxLength: 2
                          description: Range operator (EQ, NE, BT, NB, GT, GE, LT, LE)
                        NO_OF_DOCS:
                          type: integer
                          format: int32
                          description: Number of documents in this range
                        DISTINCT_VALUES:
                          type: integer
                          format: int32
                          description: Number of distinct values
                  ET_ATTR_DIST_VALUES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          maxLength: 64
                          description: Attribute name
                        ATTR_VALUE:
                          type: string
                          maxLength: 128
                          description: Attribute value
                        NO_OF_DOCS:
                          type: integer
                          format: int32
                          description: Number of documents with this value
                  ET_RESULTS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJECT_ID:
                          type: string
                          description: ID of object type instance
                        OBJECT_TYPE_ID:
                          type: string
                          maxLength: 255
                          description: Object type within a search service provider
                        PREVIEW_TEXT:
                          type: string
                          description: Preview text of result (optional)
                        RANK_VALUE:
                          type: integer
                          format: int32
                          description: Rank value for result list - between 0 and 1.000.000
                        NAVIGATION_URL:
                          type: string
                          description: URL in Enterprise Search (optional)
                        ICON_URL:
                          type: string
                          description: Special icon URL, to override generic icon URL
                        ATTR_VALUES:
                          type: array
                          items:
                            type: object
                            properties:
                              ATTRIBUTE_NAME:
                                type: string
                                description: Attribute name
                              VALUE:
                                type: string
                                description: ''
                              TYPE:
                                type: string
                                maxLength: 1
                                description: Attribute type
                  ET_RETURN_CODES:
                    type: array
                    items:
                      type: object
                      properties:
                        LOGSYS:
                          type: string
                          maxLength: 60
                          description: Logical system (format length like XI)
                        OBJECT_TYPE_ID:
                          type: string
                          maxLength: 255
                          description: Object type within a search service provider
                        TYPE:
                          type: string
                          maxLength: 1
                          description: 'Message type: S Success, E Error, W Warning, I Info, A Abort'
                        ID:
                          type: string
                          maxLength: 20
                          description: Message Class
                        NUMBER:
                          type: integer
                          format: int64
                          description: Message Number
                        MESSAGE:
                          type: string
                          maxLength: 220
                          description: Message Text
                        LOG_NO:
                          type: string
                          maxLength: 20
                          description: 'Application log: log number'
                        LOG_MSG_NO:
                          type: integer
                          format: int64
                          description: 'Application log: Internal message serial number'
                        MESSAGE_V1:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V2:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V3:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V4:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        PARAMETER:
                          type: string
                          maxLength: 32
                          description: Parameter Name
                        ROW:
                          type: integer
                          format: int32
                          description: Lines in parameter
                        FIELD:
                          type: string
                          maxLength: 30
                          description: Field in parameter
                  ET_RUNTIMES:
                    type: array
                    items:
                      type: object
                      properties:
                        DURATION:
                          type: integer
                          format: int64
                          description: UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun)
                        COMPONENT_NAME:
                          type: string
                          maxLength: 30
                          description: 30 Characters
                        STORETIME:
                          type: integer
                          format: int64
                          description: UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun)
                        HOST:
                          type: string
                          maxLength: 32
                          description: Name of Current Application Server
                  EV_NO_OF_ALL_HITS:
                    type: integer
                    format: int32
                    description: Return Parameter
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
