openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/TREX_RFC_CREATE_INDEX:
    post:
      tags:
      - TREX_RFC_ADMINISTRATION
      summary: Create Index
      operationId: /rfc/TREX_RFC_CREATE_INDEX
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ALL_ATTRS_FREESTYLE:
                  type: integer
                  format: int64
                  description: '1: all Attrs are FreeStyle relevant'
                ANALYZER_TYPE:
                  type: string
                  format: byte
                  description: '0: false, 1: true'
                AUTO_CREATE_LANGUAGES:
                  type: string
                  format: byte
                  description: Language indexes are created automatically
                CREATE_ON_SAME_LOCATION_AS:
                  type: string
                  format: byte
                  description: '0: false, 1: true'
                DESCRIPTION:
                  type: string
                  format: byte
                  description: Description
                DIRECT_USE:
                  type: integer
                  format: int64
                  default: 0
                  description: '0: copy data from importPath to default location (default)   1: don''t copy'
                DOCS_CHANGE_LANGUAGE:
                  type: integer
                  format: int64
                  description: '0: false, 1: true'
                DUPLICATE_DETECTION:
                  type: string
                  format: byte
                  description: Duplicate documents are checked
                ESTIMATED_SIZE:
                  type: integer
                  format: int64
                  default: 0
                  description: Estimated index size
                FAST_PREPROCESSING:
                  type: string
                  format: byte
                  description: Indicator
                FAST_UPDATE_WITH_TEMP_DELTA:
                  type: integer
                  format: int64
                  description: '0: false, 1: true'
                IMPORT_PATH:
                  type: string
                  format: byte
                  description: path where index formerly exported
                IMPORT_WRITABLE:
                  type: integer
                  format: int64
                  default: 1
                  description: '0: index will be just readable 1: create also write version'
                INDEXSERVER_LOCATION:
                  type: string
                  format: byte
                  description: Host and Port of the index server
                INDEX_ID:
                  type: string
                  format: byte
                  description: Index Id
                INDEX_TYPE:
                  type: string
                  format: byte
                  description: Indicator
                INSERT_ONLY:
                  type: string
                  format: byte
                  description: Insert only Mode
                IS_PUBLIC:
                  type: string
                  format: byte
                  default: ''
                  description: '''X'': Index is published'
                IS_SEARCHABLE:
                  type: string
                  format: byte
                  description: Index can be used for searching
                KEEP_CONTENT:
                  type: string
                  format: byte
                  description: Content is stored on disk
                LANGUAGE:
                  type: string
                  format: byte
                  default: ''
                  description: Language
                LIFETIME_FOR_TEMP_INDEX:
                  type: integer
                  format: int64
                  description: '0: false, 1: true'
                LOGICAL_INDEX_TYPE:
                  type: string
                  format: byte
                  description: Indicator
                MEMORY_INDEX:
                  type: string
                  format: byte
                  description: Memory index
                MULTILANG_DOCS:
                  type: string
                  format: byte
                  description: '''X'': documents with same key and different language are allowed'
                NO_PHYSICAL_INDEXES:
                  type: integer
                  format: int64
                  description: number of physical indexes to be created
                NUMBER_SEPARATOR:
                  type: string
                  format: byte
                  description: Insert only Mode
                PRECALCULATE_FEATURES:
                  type: string
                  format: byte
                  description: Document features are calculated and stored on disk
                QUEUESERVER_LOCATION:
                  type: string
                  format: byte
                  description: Host and Port of the queue server
                SIZE_FOR_DELTA_INDEX:
                  type: integer
                  format: int64
                  description: Max no of docs that are kept in the delta index
                TEXTMINING_RELEVANT:
                  type: string
                  format: byte
                  default: ''
                  description: Text mining relevant
                TOKEN_SEPARATOR:
                  type: string
                  format: byte
                  description: Insert only Mode
                USE_EXTERNAL_KEY:
                  type: string
                  format: byte
                  description: Indicator
                USE_QUEUESERVER:
                  type: string
                  format: byte
                  default: ''
                  description: '''X'': Queue server is used'
                USE_TEMPORARY_DELTA_INDEXES:
                  type: integer
                  format: int64
                  description: '0: false, 1: true'
                ATTRIBUTE_DEFINITIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTRNAME:
                        type: string
                        format: byte
                        description: ''
                      ATTRTYPE:
                        type: string
                        format: byte
                        description: ''
                      IMPLFLAGS:
                        type: integer
                        format: int64
                        description: ''
                      TMRELEVANT:
                        type: string
                        format: byte
                        description: ''
                      GROUP:
                        type: string
                        format: byte
                        description: ''
                ATTRIBUTE_DEFINITIONS_V2:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTRNAME:
                        type: string
                        format: byte
                        description: ''
                      ATTRTYPE:
                        type: string
                        format: byte
                        description: ''
                      IMPLFLAGS:
                        type: integer
                        format: int64
                        description: ''
                      TMRELEVANT:
                        type: string
                        format: byte
                        description: ''
                      GROUP:
                        type: string
                        format: byte
                        description: ''
                      DIGITS_BEFORE:
                        type: integer
                        format: int64
                        description: ''
                      DIGITS_AFTER:
                        type: integer
                        format: int64
                        description: ''
                EXTENSIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        format: byte
                        description: ''
                FREESTYLE_SEARCH_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                KEY_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                LANGUAGE_INDEXES:
                  type: array
                  items:
                    type: object
                    properties:
                      INDEX_NAME:
                        type: string
                        format: byte
                        description: ''
                      LOCATION:
                        type: string
                        format: byte
                        description: ''
                PARTITION_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                PHYSICAL_INDEXES:
                  type: array
                  items:
                    type: object
                    properties:
                      INDEX_NAME:
                        type: string
                        format: byte
                        description: ''
                      LOCATION:
                        type: string
                        format: byte
                        description: ''
                PRELOAD_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      ATTR_NAME:
                        type: string
                        format: byte
                        description: ''
                PRELOAD_LANGUAGES:
                  type: array
                  items:
                    type: object
                    properties:
                      LANGUAGE:
                        type: string
                        format: byte
                        description: ''
              required:
              - INDEX_ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  RETURN_CODE:
                    type: integer
                    format: int64
                    description: Return code
                  RETURN_TEXT:
                    type: string
                    format: byte
                    description: Return text
                  ATTRIBUTE_DEFINITIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTRNAME:
                          type: string
                          format: byte
                          description: ''
                        ATTRTYPE:
                          type: string
                          format: byte
                          description: ''
                        IMPLFLAGS:
                          type: integer
                          format: int64
                          description: ''
                        TMRELEVANT:
                          type: string
                          format: byte
                          description: ''
                        GROUP:
                          type: string
                          format: byte
                          description: ''
                  ATTRIBUTE_DEFINITIONS_V2:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTRNAME:
                          type: string
                          format: byte
                          description: ''
                        ATTRTYPE:
                          type: string
                          format: byte
                          description: ''
                        IMPLFLAGS:
                          type: integer
                          format: int64
                          description: ''
                        TMRELEVANT:
                          type: string
                          format: byte
                          description: ''
                        GROUP:
                          type: string
                          format: byte
                          description: ''
                        DIGITS_BEFORE:
                          type: integer
                          format: int64
                          description: ''
                        DIGITS_AFTER:
                          type: integer
                          format: int64
                          description: ''
                  EXTENSIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          format: byte
                          description: ''
                  FREESTYLE_SEARCH_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                  KEY_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                  LANGUAGE_INDEXES:
                    type: array
                    items:
                      type: object
                      properties:
                        INDEX_NAME:
                          type: string
                          format: byte
                          description: ''
                        LOCATION:
                          type: string
                          format: byte
                          description: ''
                  PARTITION_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                  PHYSICAL_INDEXES:
                    type: array
                    items:
                      type: object
                      properties:
                        INDEX_NAME:
                          type: string
                          format: byte
                          description: ''
                        LOCATION:
                          type: string
                          format: byte
                          description: ''
                  PRELOAD_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        ATTR_NAME:
                          type: string
                          format: byte
                          description: ''
                  PRELOAD_LANGUAGES:
                    type: array
                    items:
                      type: object
                      properties:
                        LANGUAGE:
                          type: string
                          format: byte
                          description: ''
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
