openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/TREX_RFC_SEARCH_DOCUMENTS:
    post:
      tags:
      - TREX_RFC_TM
      summary: Search
      operationId: /rfc/TREX_RFC_SEARCH_DOCUMENTS
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ATTR_DIST_GLOBAL:
                  type: object
                  properties:
                    OPT_NUM_VALUES:
                      type: integer
                      format: int64
                      description: Optimal number of values
                    MAX_NUM_VALUES:
                      type: integer
                      format: int64
                      description: Maxiumum number of return values
                COUNT_ONLY:
                  type: string
                  format: byte
                  description: 'X: result documents are only counted'
                INDEXSERVER_LOCATION:
                  type: string
                  format: byte
                  description: Host:Port
                MAX_SNIPPET_WORDS:
                  type: integer
                  format: int64
                  description: Maximum number of words in snippets
                REQUESTED_SEARCH_RESULTS:
                  type: integer
                  format: int64
                  description: '1: Documents 2: Statistical infos, 3: Statistical overview'
                REQUEST_FLAGS:
                  type: integer
                  format: int64
                  description: '1: DidYouMean, 2: Snippets 4: TitleSnippets or a bit combina'
                RESULT_FROM:
                  type: integer
                  format: int64
                  description: from
                RESULT_TO:
                  type: integer
                  format: int64
                  description: to
                STAGING:
                  type: integer
                  format: int64
                  description: Staging
                SWICH_ON_TRACE:
                  type: integer
                  format: int64
                  description: Two digit number
                TRACE_COMPONENTS:
                  type: string
                  format: byte
                  description: Data field for RFC with frontend printing (cont.ASCII data)
                ADMIN_RESULT_DOCS:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_KEY:
                        type: string
                        format: byte
                        description: ''
                      DOC_STATUS:
                        type: integer
                        format: int64
                        description: ''
                      INDEX_ID:
                        type: string
                        format: byte
                        description: ''
                      RANK_VALUE:
                        type: integer
                        format: int64
                        description: ''
                      DOC_LANGU:
                        type: string
                        format: byte
                        description: ''
                      SEARCH_ENGINE:
                        type: string
                        format: byte
                        description: ''
                      DOC_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                ADMIN_RESULT_DOC_ATTR:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                      VALUE1:
                        type: string
                        format: byte
                        description: ''
                      VALUE2:
                        type: string
                        format: byte
                        description: ''
                      ATTR_TYPE:
                        type: string
                        format: byte
                        description: ''
                      ATTR_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                ADMIN_RESULT_DOC_CONTENT:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                      CONTENT:
                        type: string
                        format: byte
                        description: ''
                ATTR_DIST_DEFINITION:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                      BROWSING_REL:
                        type: integer
                        format: int64
                        description: ''
                      CLUSTER_SIZE:
                        type: integer
                        format: int64
                        description: ''
                      ALGORITHM:
                        type: string
                        format: byte
                        description: ''
                      GROUPING_RANGE:
                        type: string
                        format: byte
                        description: ''
                      COUNTER:
                        type: integer
                        format: int64
                        description: ''
                ATTR_DIST_OVERVIEW:
                  type: array
                  items:
                    type: object
                    properties:
                      DISCRIM_VALUE:
                        type: integer
                        format: int64
                        description: Discrimination value
                      DISTINCT_VALUES:
                        type: integer
                        format: int64
                        description: Number of distinct values
                      NO_OF_DOCS:
                        type: integer
                        format: int64
                        description: Number of documents with this attribute
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: Attribute name
                ATTR_DIST_RANGES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: Attribute name
                      GROUPNAMEFROM:
                        type: string
                        format: byte
                        description: From
                      GROUPNAMETO:
                        type: string
                        format: byte
                        description: To
                      OPERATOR:
                        type: string
                        format: byte
                        description: Range operator
                      NO_OF_DOCS:
                        type: integer
                        format: int64
                        description: Number of documents in this range
                      DISTINCT_VALUES:
                        type: integer
                        format: int64
                        description: Number of distinct values
                ATTR_DIST_VALUES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: Attribute name
                      ATTR_VALUE:
                        type: string
                        format: byte
                        description: Attribute value
                      NO_OF_DOCS:
                        type: integer
                        format: int64
                        description: Number of documents with this value
                HIGHLIGHT_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                INDEX_LIST:
                  type: array
                  items:
                    type: object
                    properties:
                      INDEX_ID:
                        type: string
                        format: byte
                        description: ''
                      LANGU:
                        type: string
                        format: byte
                        description: ''
                QUERY_ENTRY:
                  type: array
                  items:
                    type: object
                    properties:
                      LOCATION:
                        type: string
                        format: byte
                        description: Attribute Name
                      VALUE1:
                        type: string
                        format: byte
                        description: ''
                      VALUE2:
                        type: string
                        format: byte
                        description: ''
                      ROWTYPE:
                        type: string
                        format: byte
                        description: ''
                      OPERATOR:
                        type: string
                        format: byte
                        description: ''
                      CONTENT_TYPE:
                        type: string
                        format: byte
                        description: ''
                      TERM_ACTION:
                        type: string
                        format: byte
                        description: ''
                      TERM_WEIGHT:
                        type: integer
                        format: int64
                        description: ''
                      NEAR_WIDTH:
                        type: integer
                        format: int64
                        description: ''
                      NEAR_ORDER:
                        type: integer
                        format: int64
                        description: ''
                      FUZZY_SIMILARITY:
                        type: integer
                        format: int64
                        description: ''
                      RANK_METHOD:
                        type: integer
                        format: int64
                        description: ''
                      SEARCH_FLAG:
                        type: integer
                        format: int64
                        description: ''
                      QUERY_COUNT:
                        type: integer
                        format: int64
                        description: ''
                      NODE_COUNT:
                        type: integer
                        format: int64
                        description: ''
                REQ_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                RESULT_DOCS:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_KEY:
                        type: string
                        format: byte
                        description: ''
                      DOC_STATUS:
                        type: integer
                        format: int64
                        description: ''
                      INDEX_ID:
                        type: string
                        format: byte
                        description: ''
                      RANK_VALUE:
                        type: integer
                        format: int64
                        description: ''
                      DOC_LANGU:
                        type: string
                        format: byte
                        description: ''
                      SEARCH_ENGINE:
                        type: string
                        format: byte
                        description: ''
                      DOC_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                RESULT_DOC_ATTR:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                      VALUE1:
                        type: string
                        format: byte
                        description: ''
                      VALUE2:
                        type: string
                        format: byte
                        description: ''
                      ATTR_TYPE:
                        type: string
                        format: byte
                        description: ''
                      ATTR_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                RESULT_DOC_CONTENT:
                  type: array
                  items:
                    type: object
                    properties:
                      DOC_COUNTER:
                        type: integer
                        format: int64
                        description: ''
                      CONTENT:
                        type: string
                        format: byte
                        description: ''
                SORT_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: Attribute name
                      SORT:
                        type: integer
                        format: int64
                        description: ''
                SUGGESTED_TERMS:
                  type: array
                  items:
                    type: object
                    properties:
                      QUERY_COUNT:
                        type: integer
                        format: int64
                        description: reference to the orginal query entry
                      ORIGINAL_TERM:
                        type: string
                        format: byte
                        description: original term
                      TIP:
                        type: string
                        format: byte
                        description: suggested term (did you mean)
                TERM_ATTR_INFO:
                  type: array
                  items:
                    type: object
                    properties:
                      TERM_NAME:
                        type: string
                        format: byte
                        description: ''
                      INDEX_ID:
                        type: string
                        format: byte
                        description: ''
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                      ATTR_TYPE:
                        type: string
                        format: byte
                        description: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  COMPONENT_RUNTIME:
                    type: object
                    properties:
                      RFC_SERVER_TIME:
                        type: integer
                        format: int64
                        description: ''
                      TREX_CLIENT_TIME:
                        type: integer
                        format: int64
                        description: ''
                      TREX_KERNEL_TIME:
                        type: integer
                        format: int64
                        description: ''
                  INDEX_SIZE:
                    type: integer
                    format: int64
                    description: Index size
                  LINES_WITH_LB:
                    type: object
                    properties:
                      TYPE:
                        type: integer
                        format: int64
                        description: ''
                      LINE:
                        type: string
                        format: byte
                        description: ''
                      CONTINUE_FLAG:
                        type: string
                        format: byte
                        description: ''
                  NO_OF_ALL_HITS:
                    type: integer
                    format: int64
                    description: Number of all Hits in Index
                  NO_OF_HITS:
                    type: integer
                    format: int64
                    description: Number of Hits
                  RETURN_CODE:
                    type: integer
                    format: int64
                    description: Return code
                  RETURN_TEXT:
                    type: string
                    format: byte
                    description: Return text
                  ADMIN_RESULT_DOCS:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_KEY:
                          type: string
                          format: byte
                          description: ''
                        DOC_STATUS:
                          type: integer
                          format: int64
                          description: ''
                        INDEX_ID:
                          type: string
                          format: byte
                          description: ''
                        RANK_VALUE:
                          type: integer
                          format: int64
                          description: ''
                        DOC_LANGU:
                          type: string
                          format: byte
                          description: ''
                        SEARCH_ENGINE:
                          type: string
                          format: byte
                          description: ''
                        DOC_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                  ADMIN_RESULT_DOC_ATTR:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                        VALUE1:
                          type: string
                          format: byte
                          description: ''
                        VALUE2:
                          type: string
                          format: byte
                          description: ''
                        ATTR_TYPE:
                          type: string
                          format: byte
                          description: ''
                        ATTR_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                  ADMIN_RESULT_DOC_CONTENT:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                        CONTENT:
                          type: string
                          format: byte
                          description: ''
                  ATTR_DIST_DEFINITION:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                        BROWSING_REL:
                          type: integer
                          format: int64
                          description: ''
                        CLUSTER_SIZE:
                          type: integer
                          format: int64
                          description: ''
                        ALGORITHM:
                          type: string
                          format: byte
                          description: ''
                        GROUPING_RANGE:
                          type: string
                          format: byte
                          description: ''
                        COUNTER:
                          type: integer
                          format: int64
                          description: ''
                  ATTR_DIST_OVERVIEW:
                    type: array
                    items:
                      type: object
                      properties:
                        DISCRIM_VALUE:
                          type: integer
                          format: int64
                          description: Discrimination value
                        DISTINCT_VALUES:
                          type: integer
                          format: int64
                          description: Number of distinct values
                        NO_OF_DOCS:
                          type: integer
                          format: int64
                          description: Number of documents with this attribute
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: Attribute name
                  ATTR_DIST_RANGES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: Attribute name
                        GROUPNAMEFROM:
                          type: string
                          format: byte
                          description: From
                        GROUPNAMETO:
                          type: string
                          format: byte
                          description: To
                        OPERATOR:
                          type: string
                          format: byte
                          description: Range operator
                        NO_OF_DOCS:
                          type: integer
                          format: int64
                          description: Number of documents in this range
                        DISTINCT_VALUES:
                          type: integer
                          format: int64
                          description: Number of distinct values
                  ATTR_DIST_VALUES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: Attribute name
                        ATTR_VALUE:
                          type: string
                          format: byte
                          description: Attribute value
                        NO_OF_DOCS:
                          type: integer
                          format: int64
                          description: Number of documents with this value
                  HIGHLIGHT_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                  INDEX_LIST:
                    type: array
                    items:
                      type: object
                      properties:
                        INDEX_ID:
                          type: string
                          format: byte
                          description: ''
                        LANGU:
                          type: string
                          format: byte
                          description: ''
                  QUERY_ENTRY:
                    type: array
                    items:
                      type: object
                      properties:
                        LOCATION:
                          type: string
                          format: byte
                          description: Attribute Name
                        VALUE1:
                          type: string
                          format: byte
                          description: ''
                        VALUE2:
                          type: string
                          format: byte
                          description: ''
                        ROWTYPE:
                          type: string
                          format: byte
                          description: ''
                        OPERATOR:
                          type: string
                          format: byte
                          description: ''
                        CONTENT_TYPE:
                          type: string
                          format: byte
                          description: ''
                        TERM_ACTION:
                          type: string
                          format: byte
                          description: ''
                        TERM_WEIGHT:
                          type: integer
                          format: int64
                          description: ''
                        NEAR_WIDTH:
                          type: integer
                          format: int64
                          description: ''
                        NEAR_ORDER:
                          type: integer
                          format: int64
                          description: ''
                        FUZZY_SIMILARITY:
                          type: integer
                          format: int64
                          description: ''
                        RANK_METHOD:
                          type: integer
                          format: int64
                          description: ''
                        SEARCH_FLAG:
                          type: integer
                          format: int64
                          description: ''
                        QUERY_COUNT:
                          type: integer
                          format: int64
                          description: ''
                        NODE_COUNT:
                          type: integer
                          format: int64
                          description: ''
                  REQ_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                  RESULT_DOCS:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_KEY:
                          type: string
                          format: byte
                          description: ''
                        DOC_STATUS:
                          type: integer
                          format: int64
                          description: ''
                        INDEX_ID:
                          type: string
                          format: byte
                          description: ''
                        RANK_VALUE:
                          type: integer
                          format: int64
                          description: ''
                        DOC_LANGU:
                          type: string
                          format: byte
                          description: ''
                        SEARCH_ENGINE:
                          type: string
                          format: byte
                          description: ''
                        DOC_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                  RESULT_DOC_ATTR:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                        VALUE1:
                          type: string
                          format: byte
                          description: ''
                        VALUE2:
                          type: string
                          format: byte
                          description: ''
                        ATTR_TYPE:
                          type: string
                          format: byte
                          description: ''
                        ATTR_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                  RESULT_DOC_CONTENT:
                    type: array
                    items:
                      type: object
                      properties:
                        DOC_COUNTER:
                          type: integer
                          format: int64
                          description: ''
                        CONTENT:
                          type: string
                          format: byte
                          description: ''
                  SORT_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: Attribute name
                        SORT:
                          type: integer
                          format: int64
                          description: ''
                  SUGGESTED_TERMS:
                    type: array
                    items:
                      type: object
                      properties:
                        QUERY_COUNT:
                          type: integer
                          format: int64
                          description: reference to the orginal query entry
                        ORIGINAL_TERM:
                          type: string
                          format: byte
                          description: original term
                        TIP:
                          type: string
                          format: byte
                          description: suggested term (did you mean)
                  TERM_ATTR_INFO:
                    type: array
                    items:
                      type: object
                      properties:
                        TERM_NAME:
                          type: string
                          format: byte
                          description: ''
                        INDEX_ID:
                          type: string
                          format: byte
                          description: ''
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                        ATTR_TYPE:
                          type: string
                          format: byte
                          description: ''
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
