openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/BICS_PROV_VAR_GET_VARIABLES:
    post:
      tags:
      - RSBOLAP_BICS_PROVIDER_VAR
      operationId: /rfc/BICS_PROV_VAR_GET_VARIABLES
      requestBody:
        content:
          application/json:
            schema:
              properties:
                I_APPLICATION_HANDLE:
                  type: integer
                  format: int64
                I_MERGE_VARIABLES:
                  type: string
                  default: RS_C_TRUE
                  maxLength: 1
                I_VARIABLE_CONTAINER_HANDLE:
                  type: integer
                  format: int64
                E_T_MESSAGE:
                  type: array
                  items:
                    type: object
                    properties:
                      CONTEXT_ID:
                        type: integer
                        format: int32
                        description: Object ID
                      MSGTY:
                        type: string
                        maxLength: 1
                        description: Message Type
                      MSGID:
                        type: string
                        maxLength: 20
                        description: Message Class
                      MSGNO:
                        type: integer
                        format: int64
                        description: Message Number
                      MSGV1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MSGV2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MSGV3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      MSGV4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      TEXT:
                        type: string
                        maxLength: 220
                        description: Message Text
                E_T_META_VARIABLE:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        maxLength: 40
                        description: Object Name
                      TECHNICAL_NAME:
                        type: string
                        maxLength: 40
                        description: Object Name
                      ID:
                        type: integer
                        format: int32
                        description: Object ID
                      TEXT:
                        type: string
                        maxLength: 60
                        description: Charact. text
                      MANDATORY:
                        type: string
                        maxLength: 1
                        description: 'Boolean  enumValues: X=True,""=False'
                        enum:
                        - X
                        - ''
                      INPUT_ENABLED:
                        type: string
                        maxLength: 1
                        description: 'Boolean  enumValues: X=True,""=False'
                        enum:
                        - X
                        - ''
                      STATE_VARIABLE:
                        type: string
                        maxLength: 1
                        description: 'Boolean  enumValues: X=True,""=False'
                        enum:
                        - X
                        - ''
                      SUPPORTS_VALUE_HELP:
                        type: string
                        maxLength: 1
                        description: 'Boolean  enumValues: X=True,""=False'
                        enum:
                        - X
                        - ''
                      VARTYP:
                        type: integer
                        format: int64
                        description: 'Type of a Report Variable  enumValues: 2=Hierarchy nodes,4=Formula,5=Hierarchy,3=Text,1=Characteristic value'
                        enum:
                        - '2'
                        - '4'
                        - '5'
                        - '3'
                        - '1'
                      VPARSEL:
                        type: string
                        maxLength: 1
                        description: 'Parameter Selection: Single Value, Interval, Selection Opt.  enumValues: P=Single value (parameters),S=Selection option,""=Default,M=Multiple Single Values,I=Interval'
                        enum:
                        - P
                        - S
                        - ''
                        - M
                        - I
                      ENTRYTP:
                        type: integer
                        format: int64
                        description: 'Entry required  enumValues: 0=Optional Variable Entry,2=Mandatory, Initial Value not Allowed,1=Mandatory Variable Entry'
                        enum:
                        - '0'
                        - '2'
                        - '1'
                      IS_PERSONALIZED:
                        type: string
                        maxLength: 1
                        description: 'Boolean  enumValues: X=True,""=False'
                        enum:
                        - X
                        - ''
                E_T_STATE_VARIABLE:
                  type: array
                  items:
                    type: object
                    properties:
                      ID:
                        type: integer
                        format: int32
                        description: Object ID
                      VALUE_NAME:
                        type: string
                        maxLength: 40
                        description: Object Name
                      VALUE_TEXT:
                        type: string
                        maxLength: 60
                        description: Charact. text
                      VALUE_NUMBER:
                        type: number
                        description: Value Field in the OLAP Processor
                I_T_STATISTIC_INFO:
                  type: array
                  items:
                    type: object
                    properties:
                      EVENTID:
                        type: integer
                        format: int64
                        description: OLAP Statistics Event (Type NUMC9)
                      HANDLEID:
                        type: integer
                        format: int64
                        description: Internal ID of a Query Runtime Object
                      HANDLETP:
                        type: string
                        maxLength: 4
                        description: Internal Type of Query Runtime Object
                      OBJNAME:
                        type: string
                        maxLength: 30
                        description: OLAP Statistik Object Name  (QueryID, TemplateID,...)
                      EVTIME:
                        type: integer
                        format: int64
                        description: Validity Period
                      EVCOUNT:
                        type: integer
                        format: int64
                        description: 'BW Statistics: Number'
              required:
              - I_APPLICATION_HANDLE
              - I_VARIABLE_CONTAINER_HANDLE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  E_INPUT_NECESSARY:
                    type: string
                    maxLength: 1
                  E_TH_META_CHARACTERISTIC:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 40
                          description: Object Name
                        ALTERNATIVE_NAME:
                          type: string
                          maxLength: 40
                          description: Object Name
                        ID:
                          type: integer
                          format: int32
                          description: Object ID
                        TEXT:
                          type: string
                          maxLength: 60
                          description: Charact. text
                        HAS_SHORT_TEXT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        HAS_MEDIUM_TEXT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        HAS_LONG_TEXT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        HAS_TEXT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        SUPPORTS_LOWERCASE_KEYS:
                          type: string
                          maxLength: 1
                          description: Boolean
                        HAS_COMPOUNDMENT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        HAS_CONV_EXIT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        INTTP:
                          type: string
                          maxLength: 1
                          description: ABAP data type (C,D,N,...)
                        DEFAULT_MEMBER_ACCESS_MODE:
                          type: string
                          maxLength: 1
                          description: Selection of Filter Values for Query Execution
                        IS_DOCUMENT_RELEVANT:
                          type: string
                          maxLength: 1
                          description: Boolean
                        BASE_CHARACTERISTIC:
                          type: string
                          maxLength: 30
                          description: Reference characteristic
                        DEFAULT_SELECTOR_PRSNT:
                          type: string
                          maxLength: 1
                          description: Filter Display
                        SELECTION_MODE:
                          type: string
                          maxLength: 1
                          description: 'Parameter Selection: Single Value, Interval, Selection Opt.'
                        BO_NAME:
                          type: string
                          description: Character string of any length
                        BO_NAMESPACE:
                          type: string
                          description: Character string of any length
                        BON_NAME:
                          type: string
                          description: Character string of any length
                        BON_NAMESPACE:
                          type: string
                          description: Character string of any length
                        BON_CCTS_NAME:
                          type: string
                          description: Character string of any length
                        BON_CCTS_NAMESPACE:
                          type: string
                          description: Character string of any length
                        OBN_SYSTEM_ALIAS:
                          type: string
                          maxLength: 10
                          description: System Alias for Object-Based Navigation
                        USED_FOR_NAVIGATION:
                          type: string
                          maxLength: 1
                          description: Boolean
                        USED_FOR_SELECTION_SPACE:
                          type: string
                          maxLength: 1
                          description: Boolean
                        USED_FOR_DATA_CELL_DEFINITION:
                          type: string
                          maxLength: 1
                          description: Boolean
                        CONTAINS_KEYFIGURES:
                          type: string
                          maxLength: 1
                          description: Boolean
                        SUPPORTS_AGGREGATION:
                          type: string
                          maxLength: 1
                          description: Boolean
                        SUPPORTS_SELECTION:
                          type: string
                          maxLength: 1
                          description: Boolean
                        GIS_TYPE:
                          type: integer
                          format: int64
                          description: Geographical type for a characteristic
                        GIS_ATTRIBUTE_NAME:
                          type: string
                          maxLength: 30
                          description: Geographical attribute
                        BOR_OBJTYP:
                          type: string
                          maxLength: 10
                          description: Object Type
                        SUPPORTS_HIERARCHIES:
                          type: string
                          maxLength: 1
                          description: Boolean
                        SUPPORTS_SORT_BY_SELECT_SPACE:
                          type: string
                          maxLength: 1
                          description: Boolean
                        IS_STRUCTURE:
                          type: string
                          maxLength: 1
                          description: Boolean
                        DEFAULT_RS_ACCESS_MODE:
                          type: string
                          maxLength: 1
                          description: Display Values Not Posted
                        ATTRIBUTES:
                          type: array
                          items:
                            type: object
                            properties:
                              NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              ALTERNATIVE_NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              ID:
                                type: integer
                                format: int32
                                description: Object ID
                              TEXT:
                                type: string
                                maxLength: 60
                                description: Charact. text
                              HAS_SHORT_TEXT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HAS_MEDIUM_TEXT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HAS_LONG_TEXT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HAS_TEXT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              SUPPORTS_LOWERCASE_KEYS:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HAS_COMPOUNDMENT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HAS_CONV_EXIT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              INTTP:
                                type: string
                                maxLength: 1
                                description: ABAP data type (C,D,N,...)
                              DEFAULT_MEMBER_ACCESS_MODE:
                                type: string
                                maxLength: 1
                                description: Selection of Filter Values for Query Execution
                              IS_DOCUMENT_RELEVANT:
                                type: string
                                maxLength: 1
                                description: Boolean
                              BASE_CHARACTERISTIC:
                                type: string
                                maxLength: 30
                                description: Reference characteristic
                              DEFAULT_SELECTOR_PRSNT:
                                type: string
                                maxLength: 1
                                description: Filter Display
                              SELECTION_MODE:
                                type: string
                                maxLength: 1
                                description: 'Parameter Selection: Single Value, Interval, Selection Opt.'
                              BO_NAME:
                                type: string
                                description: Character string of any length
                              BO_NAMESPACE:
                                type: string
                                description: Character string of any length
                              BON_NAME:
                                type: string
                                description: Character string of any length
                              BON_NAMESPACE:
                                type: string
                                description: Character string of any length
                              BON_CCTS_NAME:
                                type: string
                                description: Character string of any length
                              BON_CCTS_NAMESPACE:
                                type: string
                                description: Character string of any length
                              OBN_SYSTEM_ALIAS:
                                type: string
                                maxLength: 10
                                description: System Alias for Object-Based Navigation
                              SUPPORTS_MEMBER_ACCESS:
                                type: string
                                maxLength: 1
                                description: Boolean
                        RS_ACCESS_MODES:
                          type: array
                          items:
                            type: object
                            properties:
                              MODE:
                                type: string
                                maxLength: 1
                                description: Display Values Not Posted
                              TEXT:
                                type: string
                                maxLength: 60
                                description: Charact. text
                        STRUCTURE_MEMBERS:
                          type: array
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                format: int32
                                description: Object ID
                              NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              ALTERNATIVE_NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              TEXT:
                                type: string
                                maxLength: 60
                                description: Charact. text
                              PARENT_ID:
                                type: integer
                                format: int32
                                description: Object ID
                              INITIAL_DRILLSTATE:
                                type: integer
                                format: int32
                                description: Expansion Status of a Hierarchy Node
                              BASED_ON_TLOGO:
                                type: string
                                maxLength: 4
                                description: 'BW: Object Type (TLOGO)'
                              BASED_ON_NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              BASED_ON_TEXT:
                                type: string
                                maxLength: 60
                                description: Charact. text
                  E_TH_STATE_CHARACTERISTIC:
                    type: array
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          format: int32
                          description: Object ID
                        RESULT_SET_PRESENTATION:
                          type: integer
                          format: int32
                          description: Amount of Presentations Encrypted as Bit String
                        MEMBER_ACCESS_INDIV_SETTINGS:
                          type: string
                          maxLength: 1
                          description: Boolean
                        MEMBER_ACCESS_PRESENTATION:
                          type: integer
                          format: int32
                          description: Amount of Presentations Encrypted as Bit String
                        MEMBER_ACCESS_MODE:
                          type: string
                          maxLength: 1
                          description: Read Mode(F4) for Master Data Read Services
                        RESULT_SET_SORTING:
                          type: object
                          properties:
                            TYPE:
                              type: string
                              maxLength: 1
                              description: 'Sort Type  enumValues: K=(K)ey: Sort according to key,W=(V)alue: Sort according to key figure,S=(S)election : Sort according to selection,H=(H)ierarchy Sorting: Sorting as in a Hierarchy,T=(T)ext: Sort according to description'
                              enum:
                              - K
                              - W
                              - S
                              - H
                              - T
                            DIRECTION:
                              type: string
                              maxLength: 1
                              description: 'Sort Direction  enumValues: A=ascending,D=descending'
                              enum:
                              - A
                              - D
                            ATTRIBUTE_ID:
                              type: integer
                              format: int32
                              description: Object ID
                            DATA_CELL_ID:
                              type: integer
                              format: int32
                              description: Object ID
                        RESULT_VISIBILITY:
                          type: string
                          maxLength: 1
                          description: Visibility of Objects (for example Results Rows)
                        MEMBER_ACCESS_SORTING:
                          type: object
                          properties:
                            TYPE:
                              type: string
                              maxLength: 1
                              description: 'Sort Type  enumValues: K=(K)ey: Sort according to key,W=(V)alue: Sort according to key figure,S=(S)election : Sort according to selection,H=(H)ierarchy Sorting: Sorting as in a Hierarchy,T=(T)ext: Sort according to description'
                              enum:
                              - K
                              - W
                              - S
                              - H
                              - T
                            DIRECTION:
                              type: string
                              maxLength: 1
                              description: 'Sort Direction  enumValues: A=ascending,D=descending'
                              enum:
                              - A
                              - D
                            ATTRIBUTE_ID:
                              type: integer
                              format: int32
                              description: Object ID
                            DATA_CELL_ID:
                              type: integer
                              format: int32
                              description: Object ID
                        STRUCTURE_HRY_DRILL_LEVEL:
                          type: integer
                          format: int32
                          description: Level Number in a Hierarchy
                        STRUCTURE_HRY_NODE_ALIGNMENT:
                          type: string
                          maxLength: 1
                          description: Alignment of Objects (top/left, bottom/right, default)
                        RESULT_ACCESS_MODE:
                          type: string
                          maxLength: 1
                          description: Display Values Not Posted
                        ATTRIBUTES:
                          type: array
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                format: int32
                                description: Object ID
                              RESULT_SET_PRESENTATION:
                                type: integer
                                format: int32
                                description: Amount of Presentations Encrypted as Bit String
                              MEMBER_ACCESS_INDIV_SETTINGS:
                                type: string
                                maxLength: 1
                                description: Boolean
                              MEMBER_ACCESS_PRESENTATION:
                                type: integer
                                format: int32
                                description: Amount of Presentations Encrypted as Bit String
                              MEMBER_ACCESS_MODE:
                                type: string
                                maxLength: 1
                                description: Read Mode(F4) for Master Data Read Services
                              MEMBER_ACCESS_SORTING:
                                type: object
                                properties:
                                  TYPE:
                                    type: string
                                    maxLength: 1
                                    description: 'Sort Type  enumValues: K=(K)ey: Sort according to key,W=(V)alue: Sort according to key figure,S=(S)election : Sort according to selection,H=(H)ierarchy Sorting: Sorting as in a Hierarchy,T=(T)ext: Sort according to description'
                                    enum:
                                    - K
                                    - W
                                    - S
                                    - H
                                    - T
                                  DIRECTION:
                                    type: string
                                    maxLength: 1
                                    description: 'Sort Direction  enumValues: A=ascending,D=descending'
                                    enum:
                                    - A
                                    - D
                                  ATTRIBUTE_ID:
                                    type: integer
                                    format: int32
                                    description: Object ID
                                  DATA_CELL_ID:
                                    type: integer
                                    format: int32
                                    description: Object ID
                        MEMBER_ACCESS_ATTRIBUTES:
                          type: array
                          items:
                            type: integer
                            format: int32
                            description: ID for an Object
                        RESULT_SET_ATTRIBUTES:
                          type: array
                          items:
                            type: integer
                            format: int32
                            description: ID for an Object
                  E_TSX_SELECTION:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 40
                          description: Object Name
                        SELECTION:
                          type: array
                          items:
                            type: object
                            properties:
                              SIGN:
                                type: string
                                maxLength: 1
                                description: Sign for a Selection
                              OPERATOR:
                                type: string
                                maxLength: 2
                                description: Operator in Selections
                              ATTRIBUTE_NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              PRESENTATION:
                                type: integer
                                format: int32
                                description: Display of an Object
                              LOW:
                                type: string
                                maxLength: 70
                                description: Field for any characteristic value (external display)
                              LOW_IS_EXIT_VARIABLE:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HIGH:
                                type: string
                                maxLength: 70
                                description: Field for any characteristic value (external display)
                              HIGH_IS_EXIT_VARIABLE:
                                type: string
                                maxLength: 1
                                description: Boolean
                              HIERARCHY_NAME:
                                type: string
                                maxLength: 40
                                description: Object Name
                              HIERARCHY_VERSION:
                                type: string
                                maxLength: 3
                                description: Hierarchy version
                              HIERARCHY_DUEDATE:
                                type: string
                                format: date
                                description: Valid-to date
                              LOW_EXIT_SHIFT:
                                type: integer
                                format: int32
                                description: Shift for Exit Variables
                              HIGH_EXIT_SHIFT:
                                type: integer
                                format: int32
                                description: Shift for Exit Variables
                  E_T_MESSAGE:
                    type: array
                    items:
                      type: object
                      properties:
                        CONTEXT_ID:
                          type: integer
                          format: int32
                          description: Object ID
                        MSGTY:
                          type: string
                          maxLength: 1
                          description: Message Type
                        MSGID:
                          type: string
                          maxLength: 20
                          description: Message Class
                        MSGNO:
                          type: integer
                          format: int64
                          description: Message Number
                        MSGV1:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MSGV2:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MSGV3:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MSGV4:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        TEXT:
                          type: string
                          maxLength: 220
                          description: Message Text
                  E_T_META_VARIABLE:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 40
                          description: Object Name
                        TECHNICAL_NAME:
                          type: string
                          maxLength: 40
                          description: Object Name
                        ID:
                          type: integer
                          format: int32
                          description: Object ID
                        TEXT:
                          type: string
                          maxLength: 60
                          description: Charact. text
                        MANDATORY:
                          type: string
                          maxLength: 1
                          description: 'Boolean  enumValues: X=True,""=False'
                          enum:
                          - X
                          - ''
                        INPUT_ENABLED:
                          type: string
                          maxLength: 1
                          description: 'Boolean  enumValues: X=True,""=False'
                          enum:
                          - X
                          - ''
                        STATE_VARIABLE:
                          type: string
                          maxLength: 1
                          description: 'Boolean  enumValues: X=True,""=False'
                          enum:
                          - X
                          - ''
                        SUPPORTS_VALUE_HELP:
                          type: string
                          maxLength: 1
                          description: 'Boolean  enumValues: X=True,""=False'
                          enum:
                          - X
                          - ''
                        VARTYP:
                          type: integer
                          format: int64
                          description: 'Type of a Report Variable  enumValues: 2=Hierarchy nodes,4=Formula,5=Hierarchy,3=Text,1=Characteristic value'
                          enum:
                          - '2'
                          - '4'
                          - '5'
                          - '3'
                          - '1'
                        VPARSEL:
                          type: string
                          maxLength: 1
                          description: 'Parameter Selection: Single Value, Interval, Selection Opt.  enumValues: P=Single value (parameters),S=Selection option,""=Default,M=Multiple Single Values,I=Interval'
                          enum:
                          - P
                          - S
                          - ''
                          - M
                          - I
                        ENTRYTP:
                          type: integer
                          format: int64
                          description: 'Entry required  enumValues: 0=Optional Variable Entry,2=Mandatory, Initial Value not Allowed,1=Mandatory Variable Entry'
                          enum:
                          - '0'
                          - '2'
                          - '1'
                        IS_PERSONALIZED:
                          type: string
                          maxLength: 1
                          description: 'Boolean  enumValues: X=True,""=False'
                          enum:
                          - X
                          - ''
                  E_T_STATE_VARIABLE:
                    type: array
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          format: int32
                          description: Object ID
                        VALUE_NAME:
                          type: string
                          maxLength: 40
                          description: Object Name
                        VALUE_TEXT:
                          type: string
                          maxLength: 60
                          description: Charact. text
                        VALUE_NUMBER:
                          type: number
                          description: Value Field in the OLAP Processor
                  I_T_STATISTIC_INFO:
                    type: array
                    items:
                      type: object
                      properties:
                        EVENTID:
                          type: integer
                          format: int64
                          description: OLAP Statistics Event (Type NUMC9)
                        HANDLEID:
                          type: integer
                          format: int64
                          description: Internal ID of a Query Runtime Object
                        HANDLETP:
                          type: string
                          maxLength: 4
                          description: Internal Type of Query Runtime Object
                        OBJNAME:
                          type: string
                          maxLength: 30
                          description: OLAP Statistik Object Name  (QueryID, TemplateID,...)
                        EVTIME:
                          type: integer
                          format: int64
                          description: Validity Period
                        EVCOUNT:
                          type: integer
                          format: int64
                          description: 'BW Statistics: Number'
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
