openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/TREX_RFC_AGGREGATE_SP5:
    post:
      tags:
      - TREX_RFC_TM
      summary: Aggregation
      operationId: /rfc/TREX_RFC_AGGREGATE_SP5
      requestBody:
        content:
          application/json:
            schema:
              properties:
                INDEX_ID:
                  type: string
                  format: byte
                  description: IndexId
                QUERY_ID:
                  type: string
                  format: byte
                  description: query id for tracing
                REQUESTED_SEARCH_RESULTS:
                  type: integer
                  format: int64
                  description: '1: Documents 2: Statistical infos, 3: Statistical overview'
                RESULT_FROM:
                  type: integer
                  format: int64
                  description: from
                RESULT_TO:
                  type: integer
                  format: int64
                  description: to
                STAGING:
                  type: integer
                  format: int64
                  description: Staging
                SWITCH_ON_TRACE:
                  type: integer
                  format: int64
                  description: NUMC1, e.g. for propery in setIndexProperty
                TOP_MAX_EQUALS:
                  type: integer
                  format: int64
                  description: Data field for RFC with frontend printing (cont.ASCII data)
                TOP_TYPE:
                  type: integer
                  format: int64
                  description: Data field for RFC with frontend printing (cont.ASCII data)
                TOP_VALUE:
                  type: string
                  format: byte
                  description: Data field for RFC with frontend printing (cont.ASCII data)
                TRACE_COMPONENTS:
                  type: string
                  format: byte
                  description: Data field for RFC with frontend printing (cont.ASCII data)
                AGGR_EXCEPTIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      ROW_POSITION:
                        type: integer
                        format: int32
                        description: ''
                      COLUMN_POSITION:
                        type: integer
                        format: int32
                        description: ''
                      DATA:
                        type: string
                        maxLength: 100
                        description: ''
                COMP_DESCR:
                  type: array
                  items:
                    type: object
                    properties:
                      FIELD_LENGTH:
                        type: integer
                        format: int64
                        description: Field length in character
                      BYTE_LENGTH:
                        type: integer
                        format: int64
                        description: Field length in bytes
                      BYTE_OFFSET:
                        type: integer
                        format: int64
                        description: Offset length in bytes
                      DECIMALS:
                        type: integer
                        format: int64
                        description: ''
                      FIELD_NAME:
                        type: string
                        format: byte
                        description: Fieldname in aggregation result (ETDATA)
                      FIELD_TYPE:
                        type: string
                        format: byte
                        description: ABAP Type of field in aggregation result
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: Attribute name
                      IGNORE_COLUMN:
                        type: string
                        format: byte
                        description: 'X: This column is ignored (no indexing)'
                INDEX_ALIAS_OPERATIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      ORIGIN_INDEX_ID:
                        type: string
                        format: byte
                        description: ''
                      ALIAS_INDEX_ID:
                        type: string
                        format: byte
                        description: ''
                      OPERATOR:
                        type: integer
                        format: int64
                        description: ''
                JOIN_CONDITIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      JOIN_NAME:
                        type: string
                        format: byte
                        description: ''
                      INDEX_ID1:
                        type: string
                        format: byte
                        description: ''
                      ATTR_NAME1:
                        type: string
                        format: byte
                        description: ''
                      INDEX_ID2:
                        type: string
                        format: byte
                        description: ''
                      ATTR_NAME2:
                        type: string
                        format: byte
                        description: ''
                      CONSTRAINTS:
                        type: string
                        format: byte
                        description: ''
                      JOIN_TYPE:
                        type: integer
                        format: int64
                        description: ''
                KEY_FIGURES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                      AGGREGATION_TYPE:
                        type: integer
                        format: int64
                        description: 1=SUM 2=COUNT 4=MIN 8=MAX
                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: ''
                      FEMS_NUMBER:
                        type: integer
                        format: int64
                        description: ''
                REQ_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        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: ''
                TRACE:
                  type: array
                  items:
                    type: object
                    properties:
                      TYPE:
                        type: integer
                        format: int64
                        description: ''
                      LINE:
                        type: string
                        format: byte
                        description: ''
                      CONTINUE_FLAG:
                        type: string
                        format: byte
                        description: ''
              required:
              - INDEX_ID
      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: ''
                  RETURN_CODE:
                    type: integer
                    format: int64
                    description: Return code
                  RETURN_TEXT:
                    type: string
                    format: byte
                    description: Return text
                  AGGR_EXCEPTIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        ROW_POSITION:
                          type: integer
                          format: int32
                          description: ''
                        COLUMN_POSITION:
                          type: integer
                          format: int32
                          description: ''
                        DATA:
                          type: string
                          maxLength: 100
                          description: ''
                  COMP_DESCR:
                    type: array
                    items:
                      type: object
                      properties:
                        FIELD_LENGTH:
                          type: integer
                          format: int64
                          description: Field length in character
                        BYTE_LENGTH:
                          type: integer
                          format: int64
                          description: Field length in bytes
                        BYTE_OFFSET:
                          type: integer
                          format: int64
                          description: Offset length in bytes
                        DECIMALS:
                          type: integer
                          format: int64
                          description: ''
                        FIELD_NAME:
                          type: string
                          format: byte
                          description: Fieldname in aggregation result (ETDATA)
                        FIELD_TYPE:
                          type: string
                          format: byte
                          description: ABAP Type of field in aggregation result
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: Attribute name
                        IGNORE_COLUMN:
                          type: string
                          format: byte
                          description: 'X: This column is ignored (no indexing)'
                  INDEX_ALIAS_OPERATIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        ORIGIN_INDEX_ID:
                          type: string
                          format: byte
                          description: ''
                        ALIAS_INDEX_ID:
                          type: string
                          format: byte
                          description: ''
                        OPERATOR:
                          type: integer
                          format: int64
                          description: ''
                  JOIN_CONDITIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        JOIN_NAME:
                          type: string
                          format: byte
                          description: ''
                        INDEX_ID1:
                          type: string
                          format: byte
                          description: ''
                        ATTR_NAME1:
                          type: string
                          format: byte
                          description: ''
                        INDEX_ID2:
                          type: string
                          format: byte
                          description: ''
                        ATTR_NAME2:
                          type: string
                          format: byte
                          description: ''
                        CONSTRAINTS:
                          type: string
                          format: byte
                          description: ''
                        JOIN_TYPE:
                          type: integer
                          format: int64
                          description: ''
                  KEY_FIGURES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                        AGGREGATION_TYPE:
                          type: integer
                          format: int64
                          description: 1=SUM 2=COUNT 4=MIN 8=MAX
                  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: ''
                        FEMS_NUMBER:
                          type: integer
                          format: int64
                          description: ''
                  REQ_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          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: ''
                  TRACE:
                    type: array
                    items:
                      type: object
                      properties:
                        TYPE:
                          type: integer
                          format: int64
                          description: ''
                        LINE:
                          type: string
                          format: byte
                          description: ''
                        CONTINUE_FLAG:
                          type: string
                          format: byte
                          description: ''
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
