openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/IDOCTYPE_READ_COMPLETE:
    post:
      tags:
      - EDIMEXT
      summary: Read IDoc type with segments (RFC-compatible)
      operationId: /rfc/IDOCTYPE_READ_COMPLETE
      requestBody:
        content:
          application/json:
            schema:
              properties:
                PI_APPLREL:
                  type: string
                  maxLength: 10
                  description: 'IDoc Development: Application Release of Segment Definition'
                PI_CIMTYP:
                  type: string
                  maxLength: 30
                  description: Enhancement
                PI_IDOCTYP:
                  type: string
                  maxLength: 30
                  description: Basic type
                PI_RELEASE:
                  type: string
                  default: SY-SAPRL
                  maxLength: 4
                  description: Release
                PI_VERSION:
                  type: string
                  default: '3'
                  maxLength: 1
                  description: Version of IDoc record types
                PT_FIELDS:
                  type: array
                  items:
                    type: object
                    properties:
                      SEGMENTTYP:
                        type: string
                        maxLength: 30
                        description: Segment type in 30-character format
                      FIELDNAME:
                        type: string
                        maxLength: 30
                        description: Field Name
                      INTLEN:
                        type: integer
                        format: int64
                        description: Internal Length in Bytes
                      EXTLEN:
                        type: integer
                        format: int64
                        description: Output Length
                      FIELD_POS:
                        type: integer
                        format: int64
                        description: Position number of field
                      BYTE_FIRST:
                        type: integer
                        format: int64
                        description: Position of first byte
                      BYTE_LAST:
                        type: integer
                        format: int64
                        description: Position of last byte
                      ROLLNAME:
                        type: string
                        maxLength: 30
                        description: Data element (semantic domain)
                      DOMNAME:
                        type: string
                        maxLength: 30
                        description: Domain name
                      DATATYPE:
                        type: string
                        maxLength: 4
                        description: 'ABAP/4 Dictionary: Screen data type for Screen Painter  enumValues: NUMC=Character string with only digits,INT2=2-byte integer, only for length field before LCHR or LRAW,DEC=Counter or amount field with comma and sign,VARC=Long character string, no longer supported from Rel. 3.0,INT1=1-byte integer, integer number <= 255,RAW=Uninterpreted sequence of bytes,CUKY=Currency key, referenced by CURR fields,QUAN=Quantity field, points to a unit field with format UNIT,FLTP=Floating
                          point number, accurate to 8 bytes,LRAW=Long byte string, requires preceding INT2 field,PREC=Precision of a QUAN field,CHAR=Character String,ACCP=Posting period YYYYMM,INT4=4-byte integer, integer number with sign,RSTR=Byte String of Variable Length,STRG=Character String of Variable Length,LANG=Language key,TIMS=Time field (hhmmss), stored as char(6),UNIT=Unit key for QUAN fields,CLNT=Client,DATS=Date field (YYYYMMDD) stored as char(8),LCHR=Long character string, requires
                          preceding INT2 field,CURR=Currency field, stored as DEC,SSTR=Short Character String of Variable Length'
                        enum:
                        - NUMC
                        - INT2
                        - DEC
                        - VARC
                        - INT1
                        - RAW
                        - CUKY
                        - QUAN
                        - FLTP
                        - LRAW
                        - PREC
                        - CHAR
                        - ACCP
                        - INT4
                        - RSTR
                        - STRG
                        - LANG
                        - TIMS
                        - UNIT
                        - CLNT
                        - DATS
                        - LCHR
                        - CURR
                        - SSTR
                      DESCRP:
                        type: string
                        maxLength: 60
                        description: Short description of object
                      ISOCODE:
                        type: string
                        maxLength: 1
                        description: 'IDoc development: ISO code ID in field  enumValues: ""=Blank,X=Selection flag'
                        enum:
                        - ''
                        - X
                      VALUETAB:
                        type: string
                        maxLength: 30
                        description: Value table for IDoc segm. field
                PT_FVALUES:
                  type: array
                  items:
                    type: object
                    properties:
                      STRNAME:
                        type: string
                        maxLength: 30
                        description: Name of internal structure
                      FIELDNAME:
                        type: string
                        maxLength: 30
                        description: Field Name
                      FLDVALUE_L:
                        type: string
                        maxLength: 10
                        description: Lower value/single value
                      FLDVALUE_H:
                        type: string
                        maxLength: 10
                        description: Upper value
                      DESCRP:
                        type: string
                        maxLength: 60
                        description: Explanatory short text
                PT_MESSAGES:
                  type: array
                  items:
                    type: object
                    properties:
                      MESTYP:
                        type: string
                        maxLength: 30
                        description: Message Type
                      DESCRP:
                        type: string
                        maxLength: 60
                        description: Short description of object
                      IDOCTYP:
                        type: string
                        maxLength: 30
                        description: Basic type
                      CIMTYP:
                        type: string
                        maxLength: 30
                        description: Extension
                      RELEASED:
                        type: string
                        maxLength: 4
                        description: Release for which message type assignment is valid
                PT_SEGMENTS:
                  type: array
                  items:
                    type: object
                    properties:
                      NR:
                        type: integer
                        format: int64
                        description: Sequential Number of Segment in IDoc Type
                      SEGMENTTYP:
                        type: string
                        maxLength: 30
                        description: Segment type in 30-character format
                      SEGMENTDEF:
                        type: string
                        maxLength: 30
                        description: 'IDoc Development : Segment definition'
                      QUALIFIER:
                        type: string
                        maxLength: 1
                        description: 'Flag: Qualified segment in IDoc  enumValues: ""=Blank,X=Selection flag'
                        enum:
                        - ''
                        - X
                      SEGLEN:
                        type: integer
                        format: int64
                        description: Length of Field (Number of Characters)
                      PARSEG:
                        type: string
                        maxLength: 30
                        description: Segment type in 30-character format
                      PARPNO:
                        type: integer
                        format: int64
                        description: Sequential number of parent segment
                      PARFLG:
                        type: string
                        maxLength: 1
                        description: 'Flag for parent segment: Segment is start of segment group  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      MUSTFL:
                        type: string
                        maxLength: 1
                        description: 'Flag: Mandatory entry  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      OCCMIN:
                        type: integer
                        format: int64
                        description: Minimum number of segments in sequence
                      OCCMAX:
                        type: integer
                        format: int64
                        description: Maximum number of segments in sequence
                      HLEVEL:
                        type: integer
                        format: int64
                        description: Hierarchy level of IDoc type segment
                      DESCRP:
                        type: string
                        maxLength: 60
                        description: Short description of object
                      GRP_MUSTFL:
                        type: string
                        maxLength: 1
                        description: 'Flag for groups: Mandatory  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      GRP_OCCMIN:
                        type: integer
                        format: int64
                        description: Minimum number of groups in sequence
                      GRP_OCCMAX:
                        type: integer
                        format: int64
                        description: Maximum number of groups in sequence
                      REFSEGTYP:
                        type: string
                        maxLength: 30
                        description: Segment type in 30-character format
              required:
              - PI_IDOCTYP
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  PE_HEADER:
                    type: object
                    properties:
                      IDOCTYP:
                        type: string
                        maxLength: 30
                        description: Basic type
                      CIMTYP:
                        type: string
                        maxLength: 30
                        description: Extension
                      STRUCTTYPE:
                        type: string
                        maxLength: 1
                        description: 'Development object type  enumValues: E=Extension,B=Basic Type'
                        enum:
                        - E
                        - B
                      DESCRP:
                        type: string
                        maxLength: 60
                        description: Short description of object
                      PRETYP:
                        type: string
                        maxLength: 30
                        description: Predecessor of basic type or extension
                      RELEASED:
                        type: string
                        maxLength: 4
                        description: Released in
                      PRESP:
                        type: string
                        maxLength: 12
                        description: Person Responsible
                      PWORK:
                        type: string
                        maxLength: 12
                        description: Processing person
                      PLAST:
                        type: string
                        maxLength: 12
                        description: 'Last change: Person'
                      APPLREL:
                        type: string
                        maxLength: 10
                        description: Application Release in which Basic Type Was Released
                  PT_FIELDS:
                    type: array
                    items:
                      type: object
                      properties:
                        SEGMENTTYP:
                          type: string
                          maxLength: 30
                          description: Segment type in 30-character format
                        FIELDNAME:
                          type: string
                          maxLength: 30
                          description: Field Name
                        INTLEN:
                          type: integer
                          format: int64
                          description: Internal Length in Bytes
                        EXTLEN:
                          type: integer
                          format: int64
                          description: Output Length
                        FIELD_POS:
                          type: integer
                          format: int64
                          description: Position number of field
                        BYTE_FIRST:
                          type: integer
                          format: int64
                          description: Position of first byte
                        BYTE_LAST:
                          type: integer
                          format: int64
                          description: Position of last byte
                        ROLLNAME:
                          type: string
                          maxLength: 30
                          description: Data element (semantic domain)
                        DOMNAME:
                          type: string
                          maxLength: 30
                          description: Domain name
                        DATATYPE:
                          type: string
                          maxLength: 4
                          description: 'ABAP/4 Dictionary: Screen data type for Screen Painter  enumValues: NUMC=Character string with only digits,INT2=2-byte integer, only for length field before LCHR or LRAW,DEC=Counter or amount field with comma and sign,VARC=Long character string, no longer supported from Rel. 3.0,INT1=1-byte integer, integer number <= 255,RAW=Uninterpreted sequence of bytes,CUKY=Currency key, referenced by CURR fields,QUAN=Quantity field, points to a unit field with format UNIT,FLTP=Floating
                            point number, accurate to 8 bytes,LRAW=Long byte string, requires preceding INT2 field,PREC=Precision of a QUAN field,CHAR=Character String,ACCP=Posting period YYYYMM,INT4=4-byte integer, integer number with sign,RSTR=Byte String of Variable Length,STRG=Character String of Variable Length,LANG=Language key,TIMS=Time field (hhmmss), stored as char(6),UNIT=Unit key for QUAN fields,CLNT=Client,DATS=Date field (YYYYMMDD) stored as char(8),LCHR=Long character string, requires
                            preceding INT2 field,CURR=Currency field, stored as DEC,SSTR=Short Character String of Variable Length'
                          enum:
                          - NUMC
                          - INT2
                          - DEC
                          - VARC
                          - INT1
                          - RAW
                          - CUKY
                          - QUAN
                          - FLTP
                          - LRAW
                          - PREC
                          - CHAR
                          - ACCP
                          - INT4
                          - RSTR
                          - STRG
                          - LANG
                          - TIMS
                          - UNIT
                          - CLNT
                          - DATS
                          - LCHR
                          - CURR
                          - SSTR
                        DESCRP:
                          type: string
                          maxLength: 60
                          description: Short description of object
                        ISOCODE:
                          type: string
                          maxLength: 1
                          description: 'IDoc development: ISO code ID in field  enumValues: ""=Blank,X=Selection flag'
                          enum:
                          - ''
                          - X
                        VALUETAB:
                          type: string
                          maxLength: 30
                          description: Value table for IDoc segm. field
                  PT_FVALUES:
                    type: array
                    items:
                      type: object
                      properties:
                        STRNAME:
                          type: string
                          maxLength: 30
                          description: Name of internal structure
                        FIELDNAME:
                          type: string
                          maxLength: 30
                          description: Field Name
                        FLDVALUE_L:
                          type: string
                          maxLength: 10
                          description: Lower value/single value
                        FLDVALUE_H:
                          type: string
                          maxLength: 10
                          description: Upper value
                        DESCRP:
                          type: string
                          maxLength: 60
                          description: Explanatory short text
                  PT_MESSAGES:
                    type: array
                    items:
                      type: object
                      properties:
                        MESTYP:
                          type: string
                          maxLength: 30
                          description: Message Type
                        DESCRP:
                          type: string
                          maxLength: 60
                          description: Short description of object
                        IDOCTYP:
                          type: string
                          maxLength: 30
                          description: Basic type
                        CIMTYP:
                          type: string
                          maxLength: 30
                          description: Extension
                        RELEASED:
                          type: string
                          maxLength: 4
                          description: Release for which message type assignment is valid
                  PT_SEGMENTS:
                    type: array
                    items:
                      type: object
                      properties:
                        NR:
                          type: integer
                          format: int64
                          description: Sequential Number of Segment in IDoc Type
                        SEGMENTTYP:
                          type: string
                          maxLength: 30
                          description: Segment type in 30-character format
                        SEGMENTDEF:
                          type: string
                          maxLength: 30
                          description: 'IDoc Development : Segment definition'
                        QUALIFIER:
                          type: string
                          maxLength: 1
                          description: 'Flag: Qualified segment in IDoc  enumValues: ""=Blank,X=Selection flag'
                          enum:
                          - ''
                          - X
                        SEGLEN:
                          type: integer
                          format: int64
                          description: Length of Field (Number of Characters)
                        PARSEG:
                          type: string
                          maxLength: 30
                          description: Segment type in 30-character format
                        PARPNO:
                          type: integer
                          format: int64
                          description: Sequential number of parent segment
                        PARFLG:
                          type: string
                          maxLength: 1
                          description: 'Flag for parent segment: Segment is start of segment group  enumValues: ""=No,X=Yes'
                          enum:
                          - ''
                          - X
                        MUSTFL:
                          type: string
                          maxLength: 1
                          description: 'Flag: Mandatory entry  enumValues: ""=No,X=Yes'
                          enum:
                          - ''
                          - X
                        OCCMIN:
                          type: integer
                          format: int64
                          description: Minimum number of segments in sequence
                        OCCMAX:
                          type: integer
                          format: int64
                          description: Maximum number of segments in sequence
                        HLEVEL:
                          type: integer
                          format: int64
                          description: Hierarchy level of IDoc type segment
                        DESCRP:
                          type: string
                          maxLength: 60
                          description: Short description of object
                        GRP_MUSTFL:
                          type: string
                          maxLength: 1
                          description: 'Flag for groups: Mandatory  enumValues: ""=No,X=Yes'
                          enum:
                          - ''
                          - X
                        GRP_OCCMIN:
                          type: integer
                          format: int64
                          description: Minimum number of groups in sequence
                        GRP_OCCMAX:
                          type: integer
                          format: int64
                          description: Maximum number of groups in sequence
                        REFSEGTYP:
                          type: string
                          maxLength: 30
                          description: Segment type in 30-character format
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
