openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/BAPI_QADB_READ:
    post:
      tags:
      - BEQADB
      summary: Read SAP Reference Structure for Q&Adb
      operationId: /rfc/BAPI_QADB_READ
      requestBody:
        content:
          application/json:
            schema:
              properties:
                CORETEMPLATE:
                  type: string
                  maxLength: 20
                  description: Core Template ID
                INCLUDE_IMG_ASSIGNMENTS:
                  type: string
                  maxLength: 1
                  description: Put IMG assignment in hierarchy
                JOBCOUNT:
                  type: string
                  maxLength: 8
                  description: Background job number
                LANGUAGE:
                  type: string
                  default: SY-LANGU
                  maxLength: 1
                  description: Language key
                LANGUAGEISO:
                  type: string
                  maxLength: 2
                  description: Language according to ISO 639
                ROOT_STRUCTURE_ID:
                  type: string
                  format: byte
                  description: 'Root Structure (Default: System Setting in SCUS_HIER)'
                DOCUMENTATION_ASSIGNMENTS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJ_TYP:
                        type: string
                        maxLength: 4
                        description: Object Type
                      ID:
                        type: string
                        maxLength: 32
                        description: Object ID
                      GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      INFO_CLASS:
                        type: string
                        maxLength: 15
                        description: Content type
                      STRUCCLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      STRUCOBJID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      TOPICCLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      TOPICOBJID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                HIERARCHY:
                  type: array
                  items:
                    type: object
                    properties:
                      NODE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      PNODE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      SEQUENCE:
                        type: integer
                        format: int32
                        description: Sequential number
                      NODE_TYPE:
                        type: string
                        maxLength: 4
                        description: Valid Node Types in Structure Repository
                      NAME:
                        type: string
                        maxLength: 75
                        description: Explanatory text
                      FROM_OBJ:
                        type: string
                        maxLength: 1
                        description: 'Flag with values '' '' and ''X''  enumValues: ""=Not valid; not selected,X=Valid; selected'
                        enum:
                        - ''
                        - X
                      REF_TYPE:
                        type: string
                        maxLength: 4
                        description: Valid Reference Types in Structure Repository
                      REF_OBJECT:
                        type: string
                        maxLength: 32
                        description: Link ID
                      IMG_FLAG:
                        type: string
                        maxLength: 1
                        description: 'Flag with values '' '' and ''X''  enumValues: ""=Not valid; not selected,X=Valid; selected'
                        enum:
                        - ''
                        - X
                      TREE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      RTREE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      RNODE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      RMODE:
                        type: string
                        maxLength: 1
                        description: 'Reference Mode  enumValues: X=Structure referred to (included),""=Node copied with reference to its original'
                        enum:
                        - X
                        - ''
                      LEAF:
                        type: string
                        maxLength: 1
                        description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      IBU:
                        type: string
                        maxLength: 1
                        description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                      PROC_COMP:
                        type: string
                        maxLength: 20
                        description: Object definition
                      IN_SCOPE:
                        type: string
                        maxLength: 1
                        description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                        enum:
                        - ''
                        - X
                IBUTEMPLATES:
                  type: array
                  items:
                    type: object
                    properties:
                      ID:
                        type: string
                        maxLength: 20
                        description: Object definition
                NODE_ASSIGNMENTS:
                  type: array
                  items:
                    type: object
                    properties:
                      NODE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      OBJ_TYP:
                        type: string
                        maxLength: 4
                        description: Object Type
                      ID:
                        type: string
                        maxLength: 32
                        description: Object ID
                      USAGE_TYPE:
                        type: string
                        maxLength: 1
                        description: 'Relationship type  enumValues: T=Transaction assignment,O=Output assignment,C=Assignment of questions/CI templates,S=System organization unit assignment,V=Assignment of variant of diagram,I=Input assignment,Q=Question assignment,B=Business object assignment,D=Diagram assignment'
                        enum:
                        - T
                        - O
                        - C
                        - S
                        - V
                        - I
                        - Q
                        - B
                        - D
                      SEQUENCE:
                        type: integer
                        format: int32
                        description: Sequential number
                      ASSIGNMENT:
                        type: string
                        maxLength: 20
                        description: Object definition
                      NAME:
                        type: string
                        maxLength: 255
                        description: Question text
                NODE_ATTRIBUTES:
                  type: array
                  items:
                    type: object
                    properties:
                      NODE_GUID:
                        type: string
                        format: byte
                        description: 16 byte GUID
                      SIGN:
                        type: string
                        maxLength: 1
                        description: 'Sign for attribute values  enumValues: I=Valid for specified:,E=Invalid for specified:,*=Valid for all,S=Relevant for all'
                        enum:
                        - I
                        - E
                        - '*'
                        - S
                      ATTRTYP:
                        type: string
                        maxLength: 4
                        description: 'Attribute type for attribute store  enumValues: ROAD=Roadmap Type Validity,FLAV=Flavor Validity,CTRY=Country Validity,RELS=Release Validity,ROLE=Role Validity,SUBJ=Subject Validity,ROLR=Roles in Review Program Validity,IDRY=Industry Validity'
                        enum:
                        - ROAD
                        - FLAV
                        - CTRY
                        - RELS
                        - ROLE
                        - SUBJ
                        - ROLR
                        - IDRY
                      VALUE:
                        type: string
                        maxLength: 40
                        description: General value for attributes
                      SUBTYP:
                        type: string
                        maxLength: 4
                        description: Subgroup of object types in the attribute repository
                OBJECT_ASSIGNMENTS:
                  type: array
                  items:
                    type: object
                    properties:
                      OBJ_TYP:
                        type: string
                        maxLength: 4
                        description: Object Type
                      ID:
                        type: string
                        maxLength: 32
                        description: Object ID
                      USAGE_TYPE:
                        type: string
                        maxLength: 1
                        description: 'Relationship type  enumValues: T=Transaction assignment,O=Output assignment,C=Assignment of questions/CI templates,S=System organization unit assignment,V=Assignment of variant of diagram,I=Input assignment,Q=Question assignment,B=Business object assignment,D=Diagram assignment'
                        enum:
                        - T
                        - O
                        - C
                        - S
                        - V
                        - I
                        - Q
                        - B
                        - D
                      SEQUENCE:
                        type: integer
                        format: int32
                        description: Sequential number
                      ASSIGNMENT:
                        type: string
                        maxLength: 20
                        description: Object definition
                      NAME:
                        type: string
                        maxLength: 80
                        description: Description
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  DOCUMENTATION_ASSIGNMENTS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJ_TYP:
                          type: string
                          maxLength: 4
                          description: Object Type
                        ID:
                          type: string
                          maxLength: 32
                          description: Object ID
                        GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        INFO_CLASS:
                          type: string
                          maxLength: 15
                          description: Content type
                        STRUCCLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        STRUCOBJID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        TOPICCLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        TOPICOBJID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                  HIERARCHY:
                    type: array
                    items:
                      type: object
                      properties:
                        NODE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        PNODE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        SEQUENCE:
                          type: integer
                          format: int32
                          description: Sequential number
                        NODE_TYPE:
                          type: string
                          maxLength: 4
                          description: Valid Node Types in Structure Repository
                        NAME:
                          type: string
                          maxLength: 75
                          description: Explanatory text
                        FROM_OBJ:
                          type: string
                          maxLength: 1
                          description: 'Flag with values '' '' and ''X''  enumValues: ""=Not valid; not selected,X=Valid; selected'
                          enum:
                          - ''
                          - X
                        REF_TYPE:
                          type: string
                          maxLength: 4
                          description: Valid Reference Types in Structure Repository
                        REF_OBJECT:
                          type: string
                          maxLength: 32
                          description: Link ID
                        IMG_FLAG:
                          type: string
                          maxLength: 1
                          description: 'Flag with values '' '' and ''X''  enumValues: ""=Not valid; not selected,X=Valid; selected'
                          enum:
                          - ''
                          - X
                        TREE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        RTREE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        RNODE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        RMODE:
                          type: string
                          maxLength: 1
                          description: 'Reference Mode  enumValues: X=Structure referred to (included),""=Node copied with reference to its original'
                          enum:
                          - X
                          - ''
                        LEAF:
                          type: string
                          maxLength: 1
                          description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        IBU:
                          type: string
                          maxLength: 1
                          description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                        PROC_COMP:
                          type: string
                          maxLength: 20
                          description: Object definition
                        IN_SCOPE:
                          type: string
                          maxLength: 1
                          description: 'Data element for Flag - Any use  enumValues: ""=Attribute does not apply,X=Attribute applies'
                          enum:
                          - ''
                          - X
                  IBUTEMPLATES:
                    type: array
                    items:
                      type: object
                      properties:
                        ID:
                          type: string
                          maxLength: 20
                          description: Object definition
                  NODE_ASSIGNMENTS:
                    type: array
                    items:
                      type: object
                      properties:
                        NODE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        OBJ_TYP:
                          type: string
                          maxLength: 4
                          description: Object Type
                        ID:
                          type: string
                          maxLength: 32
                          description: Object ID
                        USAGE_TYPE:
                          type: string
                          maxLength: 1
                          description: 'Relationship type  enumValues: T=Transaction assignment,O=Output assignment,C=Assignment of questions/CI templates,S=System organization unit assignment,V=Assignment of variant of diagram,I=Input assignment,Q=Question assignment,B=Business object assignment,D=Diagram assignment'
                          enum:
                          - T
                          - O
                          - C
                          - S
                          - V
                          - I
                          - Q
                          - B
                          - D
                        SEQUENCE:
                          type: integer
                          format: int32
                          description: Sequential number
                        ASSIGNMENT:
                          type: string
                          maxLength: 20
                          description: Object definition
                        NAME:
                          type: string
                          maxLength: 255
                          description: Question text
                  NODE_ATTRIBUTES:
                    type: array
                    items:
                      type: object
                      properties:
                        NODE_GUID:
                          type: string
                          format: byte
                          description: 16 byte GUID
                        SIGN:
                          type: string
                          maxLength: 1
                          description: 'Sign for attribute values  enumValues: I=Valid for specified:,E=Invalid for specified:,*=Valid for all,S=Relevant for all'
                          enum:
                          - I
                          - E
                          - '*'
                          - S
                        ATTRTYP:
                          type: string
                          maxLength: 4
                          description: 'Attribute type for attribute store  enumValues: ROAD=Roadmap Type Validity,FLAV=Flavor Validity,CTRY=Country Validity,RELS=Release Validity,ROLE=Role Validity,SUBJ=Subject Validity,ROLR=Roles in Review Program Validity,IDRY=Industry Validity'
                          enum:
                          - ROAD
                          - FLAV
                          - CTRY
                          - RELS
                          - ROLE
                          - SUBJ
                          - ROLR
                          - IDRY
                        VALUE:
                          type: string
                          maxLength: 40
                          description: General value for attributes
                        SUBTYP:
                          type: string
                          maxLength: 4
                          description: Subgroup of object types in the attribute repository
                  OBJECT_ASSIGNMENTS:
                    type: array
                    items:
                      type: object
                      properties:
                        OBJ_TYP:
                          type: string
                          maxLength: 4
                          description: Object Type
                        ID:
                          type: string
                          maxLength: 32
                          description: Object ID
                        USAGE_TYPE:
                          type: string
                          maxLength: 1
                          description: 'Relationship type  enumValues: T=Transaction assignment,O=Output assignment,C=Assignment of questions/CI templates,S=System organization unit assignment,V=Assignment of variant of diagram,I=Input assignment,Q=Question assignment,B=Business object assignment,D=Diagram assignment'
                          enum:
                          - T
                          - O
                          - C
                          - S
                          - V
                          - I
                          - Q
                          - B
                          - D
                        SEQUENCE:
                          type: integer
                          format: int32
                          description: Sequential number
                        ASSIGNMENT:
                          type: string
                          maxLength: 20
                          description: Object definition
                        NAME:
                          type: string
                          maxLength: 80
                          description: Description
                  RETURN:
                    type: array
                    items:
                      type: object
                      properties:
                        TYPE:
                          type: string
                          maxLength: 1
                          description: 'Message type: S Success, E Error, W Warning, I Info, A Abort'
                        ID:
                          type: string
                          maxLength: 20
                          description: Message Class
                        NUMBER:
                          type: integer
                          format: int64
                          description: Message Number
                        MESSAGE:
                          type: string
                          maxLength: 220
                          description: Message Text
                        LOG_NO:
                          type: string
                          maxLength: 20
                          description: 'Application log: log number'
                        LOG_MSG_NO:
                          type: integer
                          format: int64
                          description: 'Application log: Internal message serial number'
                        MESSAGE_V1:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V2:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V3:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        MESSAGE_V4:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        PARAMETER:
                          type: string
                          maxLength: 32
                          description: Parameter Name
                        ROW:
                          type: integer
                          format: int32
                          description: Lines in parameter
                        FIELD:
                          type: string
                          maxLength: 30
                          description: Field in parameter
                        SYSTEM:
                          type: string
                          maxLength: 10
                          description: Logical system from which message originates
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
