openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/BX_READ_USER_MENU:
    post:
      tags:
      - SMTR_NAVIGATION_MODULES_BX
      operationId: /rfc/BX_READ_USER_MENU
      requestBody:
        content:
          application/json:
            schema:
              properties:
                DEVICE:
                  type: string
                  default: ' '
                  maxLength: 30
                  description: Device Type
                GENERATE_MINI_APP_URLS:
                  type: string
                  default: X
                  maxLength: 1
                  description: Customized ('C') or standard menu ('S') flag
                GENERATE_URL:
                  type: string
                  default: ' '
                  maxLength: 1
                GET_RFC_DESTINATION_TYPE:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Customized ('C') or standard menu ('S') flag
                LANGUAGE:
                  type: string
                  default: SY-LANGU
                  maxLength: 1
                READ_MINI_APPLICATIONS:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Customized ('C') or standard menu ('S') flag
                READ_USER_MENU:
                  type: string
                  default: X
                  maxLength: 1
                  description: Customized ('C') or standard menu ('S') flag
                REPLACE_RFC_VARIABLES:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Customized ('C') or standard menu ('S') flag
                RETRIEVE_HOMEPAGE:
                  type: string
                  default: ' '
                  maxLength: 1
                SHOW_AGR_NAME_IF_POSSIBLE:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Customized ('C') or standard menu ('S') flag
                SORT_NODES:
                  type: string
                  default: ' '
                  maxLength: 1
                USAGE_MODE:
                  type: string
                  default: ' '
                  maxLength: 2
                  description: 'URL generation mode: local or WP Server'
                USER_NAME:
                  type: string
                  default: SY-UNAME
                  maxLength: 12
                ALL_MINI_APPLICATIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      AGR_NAME:
                        type: string
                        maxLength: 30
                        description: Role Name
                      SORT_ORDER:
                        type: integer
                        format: int64
                        description: Numeric field length 5
                      APPNAME:
                        type: string
                        maxLength: 30
                        description: MiniApp Name
                      APPTYPE:
                        type: string
                        maxLength: 10
                        description: 'Type of Application  enumValues: M=MiniApp,PERS=Personalization MiniApp, Personalization Service,WEBAPP=Web Application,OFF=Offline Application'
                        enum:
                        - M
                        - PERS
                        - WEBAPP
                        - 'OFF'
                      TEXT:
                        type: string
                        maxLength: 80
                        description: Menu entry text
                      WP_TYPE:
                        type: string
                        maxLength: 20
                        description: Workplace URL Type
                      RAW_URL:
                        type: string
                        maxLength: 255
                        description: URL for the SAP Portal
                      GEN_URL:
                        type: string
                        maxLength: 2000
                        description: URL for SAP Portal
                      HEIGHT:
                        type: string
                        maxLength: 10
                        description: Height of the MiniApp
                      WIDTH:
                        type: string
                        maxLength: 10
                        description: Width of the MiniApp
                      PERSMIN:
                        type: string
                        maxLength: 30
                        description: MiniApp Name
                      REFRESH:
                        type: string
                        maxLength: 1
                        description: Auto-refresh activated
                      REFR_TIME:
                        type: string
                        maxLength: 6
                        description: Time
                      STATUS_LN:
                        type: string
                        maxLength: 1
                        description: Status Line
                      TARGET_SYS:
                        type: string
                        maxLength: 10
                        description: Logical system
                E_AGR_HOMEPAGE:
                  type: array
                  items:
                    type: object
                    properties:
                      AGR_NAME:
                        type: string
                        maxLength: 30
                        description: Role Name
                      OBJECT_ID:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      WP_TYPE:
                        type: string
                        maxLength: 20
                        description: Workplace URL Type
                      GEN_URL:
                        type: string
                        maxLength: 2000
                        description: URL for SAP Portal
                GENERATED_URLS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJECT_ID:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      WP_TYPE:
                        type: string
                        maxLength: 20
                        description: Workplace URL Type
                      GEN_URL:
                        type: string
                        maxLength: 2000
                        description: URL for SAP Portal
                MINI_APPLICATIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      AGR_NAME:
                        type: string
                        maxLength: 30
                        description: Role Name
                      SORT_ORDER:
                        type: integer
                        format: int64
                        description: Level in the menu
                      HEIGHT:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      TEXT:
                        type: string
                        maxLength: 80
                        description: Menu entry text
                      WP_TYPE:
                        type: string
                        maxLength: 20
                        description: Workplace URL Type
                      GEN_URL:
                        type: string
                        maxLength: 2000
                        description: URL for SAP Portal
                      RAW_URL:
                        type: string
                        maxLength: 2000
                        description: URL for SAP Portal
                      TARGET_SYS:
                        type: string
                        maxLength: 10
                        description: Logical system
                NEW_MINI_APPLICATIONS:
                  type: array
                  items:
                    type: object
                    properties:
                      AGR_NAME:
                        type: string
                        maxLength: 30
                        description: Role Name
                      APPNAME:
                        type: string
                        maxLength: 30
                        description: MiniApp Name
                      TEXT:
                        type: string
                        maxLength: 80
                        description: Menu entry text
                      WP_TYPE:
                        type: string
                        maxLength: 20
                        description: Workplace URL Type
                      GEN_URL:
                        type: string
                        maxLength: 2000
                        description: URL for SAP Portal
                      PRIORITY:
                        type: integer
                        format: int32
                        description: 'Priority of a MiniApp  enumValues: 3=Low priority,2=Medium priority,1=High priority'
                        enum:
                        - '3'
                        - '2'
                        - '1'
                      HEIGHT:
                        type: string
                        maxLength: 10
                        description: Height of the MiniApp
                      WIDTH:
                        type: string
                        maxLength: 10
                        description: Width of the MiniApp
                      PERSMIN:
                        type: string
                        maxLength: 30
                        description: MiniApp Name
                      REFRESH:
                        type: string
                        maxLength: 1
                        description: Auto-refresh activated
                      REFR_TIME:
                        type: string
                        maxLength: 6
                        description: Time
                      STATUS_LN:
                        type: string
                        maxLength: 1
                        description: Status Line
                      APPTYPE:
                        type: string
                        maxLength: 10
                        description: 'Type of Application  enumValues: M=MiniApp,PERS=Personalization MiniApp, Personalization Service,WEBAPP=Web Application,OFF=Offline Application'
                        enum:
                        - M
                        - PERS
                        - WEBAPP
                        - 'OFF'
                      TARGET_SYS:
                        type: string
                        maxLength: 10
                        description: Logical system
                NODE_TAB:
                  type: array
                  items:
                    type: object
                    properties:
                      AGR_NAME:
                        type: string
                        maxLength: 30
                        description: Role Name
                      ORIGIN_ID:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      PARENT_ID:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      OBJECT_ID:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      SORT_ORDER:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      MENU_LEVEL:
                        type: integer
                        format: int64
                        description: Level in the menu
                      NODE_TYPE:
                        type: string
                        maxLength: 1
                        description: Type of node ( U = URL, F = folder, T = transaction)
                      TCODE:
                        type: string
                        maxLength: 20
                        description: Current Transaction Code
                      SAP_GUID:
                        type: string
                        maxLength: 32
                        description: Unique ID - 32 characters
                      TARGET_SYS:
                        type: string
                        maxLength: 32
                        description: Logical Destination (Specified in Function Call)
                      TEXT:
                        type: string
                        maxLength: 80
                        description: Menu entry text
                      X_POS:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      Y_POS:
                        type: integer
                        format: int64
                        description: Counter for menu ID
                      INFOS:
                        type: string
                        maxLength: 12
                        description: 'Structures: name of the structure'
                      URL_TYPE:
                        type: string
                        maxLength: 20
                        description: Type of URL
                      URL:
                        type: string
                        maxLength: 255
                        description: URL for the SAP Portal
                      SOURCEROLE:
                        type: string
                        maxLength: 30
                        description: Role Name
                ROLE_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      MANDT:
                        type: string
                        maxLength: 3
                        description: Client ID of Current User
                      AGR_NAME:
                        type: string
                        maxLength: 30
                        description: Role Name
                      ATT_TYPE:
                        type: string
                        maxLength: 20
                        description: 'Attribute type  enumValues: INDUSTRY=Industry,COMPONENT=Application Component,COUNTRY=Country,MISC=Different Configuration Indicators'
                        enum:
                        - INDUSTRY
                        - COMPONENT
                        - COUNTRY
                        - MISC
                      ATT_VALUE:
                        type: string
                        maxLength: 50
                        description: Attribute values
                      ATT_NEG:
                        type: string
                        maxLength: 1
                        description: Customized ('C') or standard menu ('S') flag
                      ATT_DYN:
                        type: string
                        maxLength: 1
                        description: Customized ('C') or standard menu ('S') flag
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  ALL_MINI_APPLICATIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        AGR_NAME:
                          type: string
                          maxLength: 30
                          description: Role Name
                        SORT_ORDER:
                          type: integer
                          format: int64
                          description: Numeric field length 5
                        APPNAME:
                          type: string
                          maxLength: 30
                          description: MiniApp Name
                        APPTYPE:
                          type: string
                          maxLength: 10
                          description: 'Type of Application  enumValues: M=MiniApp,PERS=Personalization MiniApp, Personalization Service,WEBAPP=Web Application,OFF=Offline Application'
                          enum:
                          - M
                          - PERS
                          - WEBAPP
                          - 'OFF'
                        TEXT:
                          type: string
                          maxLength: 80
                          description: Menu entry text
                        WP_TYPE:
                          type: string
                          maxLength: 20
                          description: Workplace URL Type
                        RAW_URL:
                          type: string
                          maxLength: 255
                          description: URL for the SAP Portal
                        GEN_URL:
                          type: string
                          maxLength: 2000
                          description: URL for SAP Portal
                        HEIGHT:
                          type: string
                          maxLength: 10
                          description: Height of the MiniApp
                        WIDTH:
                          type: string
                          maxLength: 10
                          description: Width of the MiniApp
                        PERSMIN:
                          type: string
                          maxLength: 30
                          description: MiniApp Name
                        REFRESH:
                          type: string
                          maxLength: 1
                          description: Auto-refresh activated
                        REFR_TIME:
                          type: string
                          maxLength: 6
                          description: Time
                        STATUS_LN:
                          type: string
                          maxLength: 1
                          description: Status Line
                        TARGET_SYS:
                          type: string
                          maxLength: 10
                          description: Logical system
                  E_AGR_HOMEPAGE:
                    type: array
                    items:
                      type: object
                      properties:
                        AGR_NAME:
                          type: string
                          maxLength: 30
                          description: Role Name
                        OBJECT_ID:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        WP_TYPE:
                          type: string
                          maxLength: 20
                          description: Workplace URL Type
                        GEN_URL:
                          type: string
                          maxLength: 2000
                          description: URL for SAP Portal
                  GENERATED_URLS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJECT_ID:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        WP_TYPE:
                          type: string
                          maxLength: 20
                          description: Workplace URL Type
                        GEN_URL:
                          type: string
                          maxLength: 2000
                          description: URL for SAP Portal
                  MINI_APPLICATIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        AGR_NAME:
                          type: string
                          maxLength: 30
                          description: Role Name
                        SORT_ORDER:
                          type: integer
                          format: int64
                          description: Level in the menu
                        HEIGHT:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        TEXT:
                          type: string
                          maxLength: 80
                          description: Menu entry text
                        WP_TYPE:
                          type: string
                          maxLength: 20
                          description: Workplace URL Type
                        GEN_URL:
                          type: string
                          maxLength: 2000
                          description: URL for SAP Portal
                        RAW_URL:
                          type: string
                          maxLength: 2000
                          description: URL for SAP Portal
                        TARGET_SYS:
                          type: string
                          maxLength: 10
                          description: Logical system
                  NEW_MINI_APPLICATIONS:
                    type: array
                    items:
                      type: object
                      properties:
                        AGR_NAME:
                          type: string
                          maxLength: 30
                          description: Role Name
                        APPNAME:
                          type: string
                          maxLength: 30
                          description: MiniApp Name
                        TEXT:
                          type: string
                          maxLength: 80
                          description: Menu entry text
                        WP_TYPE:
                          type: string
                          maxLength: 20
                          description: Workplace URL Type
                        GEN_URL:
                          type: string
                          maxLength: 2000
                          description: URL for SAP Portal
                        PRIORITY:
                          type: integer
                          format: int32
                          description: 'Priority of a MiniApp  enumValues: 3=Low priority,2=Medium priority,1=High priority'
                          enum:
                          - '3'
                          - '2'
                          - '1'
                        HEIGHT:
                          type: string
                          maxLength: 10
                          description: Height of the MiniApp
                        WIDTH:
                          type: string
                          maxLength: 10
                          description: Width of the MiniApp
                        PERSMIN:
                          type: string
                          maxLength: 30
                          description: MiniApp Name
                        REFRESH:
                          type: string
                          maxLength: 1
                          description: Auto-refresh activated
                        REFR_TIME:
                          type: string
                          maxLength: 6
                          description: Time
                        STATUS_LN:
                          type: string
                          maxLength: 1
                          description: Status Line
                        APPTYPE:
                          type: string
                          maxLength: 10
                          description: 'Type of Application  enumValues: M=MiniApp,PERS=Personalization MiniApp, Personalization Service,WEBAPP=Web Application,OFF=Offline Application'
                          enum:
                          - M
                          - PERS
                          - WEBAPP
                          - 'OFF'
                        TARGET_SYS:
                          type: string
                          maxLength: 10
                          description: Logical system
                  NODE_TAB:
                    type: array
                    items:
                      type: object
                      properties:
                        AGR_NAME:
                          type: string
                          maxLength: 30
                          description: Role Name
                        ORIGIN_ID:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        PARENT_ID:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        OBJECT_ID:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        SORT_ORDER:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        MENU_LEVEL:
                          type: integer
                          format: int64
                          description: Level in the menu
                        NODE_TYPE:
                          type: string
                          maxLength: 1
                          description: Type of node ( U = URL, F = folder, T = transaction)
                        TCODE:
                          type: string
                          maxLength: 20
                          description: Current Transaction Code
                        SAP_GUID:
                          type: string
                          maxLength: 32
                          description: Unique ID - 32 characters
                        TARGET_SYS:
                          type: string
                          maxLength: 32
                          description: Logical Destination (Specified in Function Call)
                        TEXT:
                          type: string
                          maxLength: 80
                          description: Menu entry text
                        X_POS:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        Y_POS:
                          type: integer
                          format: int64
                          description: Counter for menu ID
                        INFOS:
                          type: string
                          maxLength: 12
                          description: 'Structures: name of the structure'
                        URL_TYPE:
                          type: string
                          maxLength: 20
                          description: Type of URL
                        URL:
                          type: string
                          maxLength: 255
                          description: URL for the SAP Portal
                        SOURCEROLE:
                          type: string
                          maxLength: 30
                          description: Role Name
                  ROLE_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        MANDT:
                          type: string
                          maxLength: 3
                          description: Client ID of Current User
                        AGR_NAME:
                          type: string
                          maxLength: 30
                          description: Role Name
                        ATT_TYPE:
                          type: string
                          maxLength: 20
                          description: 'Attribute type  enumValues: INDUSTRY=Industry,COMPONENT=Application Component,COUNTRY=Country,MISC=Different Configuration Indicators'
                          enum:
                          - INDUSTRY
                          - COMPONENT
                          - COUNTRY
                          - MISC
                        ATT_VALUE:
                          type: string
                          maxLength: 50
                          description: Attribute values
                        ATT_NEG:
                          type: string
                          maxLength: 1
                          description: Customized ('C') or standard menu ('S') flag
                        ATT_DYN:
                          type: string
                          maxLength: 1
                          description: Customized ('C') or standard menu ('S') flag
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
