openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/SWP_WORKFLOW_HEADER_READ:
    post:
      tags:
      - SWP1
      operationId: /rfc/SWP_WORKFLOW_HEADER_READ
      requestBody:
        content:
          application/json:
            schema:
              properties:
                COMPATIBILITY_MODE:
                  type: string
                  default: X
                  maxLength: 1
                  description: ID of workflow instance
                WF_ID:
                  type: integer
                  format: int64
                  description: ID of workflow instance
              required:
              - COMPATIBILITY_MODE
              - WF_ID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  SWP_WF_HEADER:
                    type: object
                    properties:
                      CLIENT:
                        type: string
                        maxLength: 3
                        description: Client
                      WF_ID:
                        type: integer
                        format: int64
                        description: Workflow ID
                      DELETED:
                        type: string
                        maxLength: 1
                        description: 'Workflow: Delete flag for workflow data which is old  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      SUSPENDED:
                        type: string
                        maxLength: 1
                        description: 'Workflow: Flag: Workflow (item) currently suspended  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      WFD_ID:
                        type: string
                        maxLength: 10
                        description: Number of workflow definition
                      WFD_VERS:
                        type: string
                        maxLength: 4
                        description: Version
                      WFD_EXETYP:
                        type: string
                        maxLength: 1
                        description: 'Workflow Type  enumValues: E=Runtime,R=Ad Hoc Runtime,S=Definition,D=Ad Hoc Definition,C=Configuration Definition,A=Configuration Runtime'
                        enum:
                        - E
                        - R
                        - S
                        - D
                        - C
                        - A
                      WFD_NAME:
                        type: string
                        maxLength: 40
                        description: Short Text from Task
                      REQ_ID:
                        type: string
                        maxLength: 90
                        description: 'Workflow instances: ID of the requester of a workflow exec.'
                      REQ_SYSTEM:
                        type: string
                        maxLength: 10
                        description: System
                      PRIORITY:
                        type: integer
                        format: int64
                        description: 'Priority  enumValues: 1=1 Highest - Express,6=6 Low,3=3 Higher,9=9 Lowest,8=8 Very low,5=5 Medium,7=7 Lower,2=2 Very high,4=4 High'
                        enum:
                        - '1'
                        - '6'
                        - '3'
                        - '9'
                        - '8'
                        - '5'
                        - '7'
                        - '2'
                        - '4'
                      CALENDAR:
                        type: string
                        maxLength: 2
                        description: 'Workflow definition: Factory calendar'
                      WF_ADMIN:
                        type: string
                        maxLength: 14
                        description: Workflow System Administrator
                      ADHOC_MOD:
                        type: string
                        maxLength: 1
                        description: 'Workflow: Flag: Was the workflow definition changed ad hoc?  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      NODE_COUNT:
                        type: integer
                        format: int32
                        description: Max. node number in workflow (termination condition)
                      WF_INITIAT:
                        type: string
                        maxLength: 14
                        description: Initiator of workflow instance
                      MAX_NODES:
                        type: integer
                        format: int32
                        description: Max. node number in workflow (termination condition)
                      MAX_SUBWF:
                        type: integer
                        format: int32
                        description: Maximum subworkflow level (termination criterion)
                      NO_WICHAIN:
                        type: string
                        maxLength: 1
                        description: 'Flag: Synchronous advancing  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      RETURNTYP:
                        type: string
                        maxLength: 2
                        description: 'Type of Return Value  enumValues: RV=Return value of method                     [C255],CX=Class-Based Exception,RC=Return code of method                      [C4],EV=Terminating event (object type + event)    [C74]'
                        enum:
                        - RV
                        - CX
                        - RC
                        - EV
                      LAST_WI_RE:
                        type: string
                        maxLength: 255
                        description: Character value
                      NO_LOGGING:
                        type: string
                        maxLength: 1
                        description: 'Minimize Number of Entries in Workflow Log  enumValues: ""=Only log success messages and errors,1=No restrictions on logging,2=Only log errors'
                        enum:
                        - ''
                        - '1'
                        - '2'
                      TRANSIENT:
                        type: string
                        maxLength: 1
                        description: 'WF: Indicator for transient workflow'
                      CANC_ERROR:
                        type: string
                        maxLength: 1
                        description: 'Workflow: Error Canceling a Work Item  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      COMP_ERROR:
                        type: string
                        maxLength: 1
                        description: 'Workflow: Error When Completing a Work Item  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      TECH_STATE:
                        type: integer
                        format: int64
                        description: 'WFM: Technical Status of Workflow Execution  enumValues: 06=Breakpoint set,01=being executed,02=completed,05=Selected for Cancellation,04=Receive Error,03=Terminated'
                        enum:
                        - '06'
                        - '01'
                        - '02'
                        - '05'
                        - '04'
                        - '03'
                      CS_WI_ID:
                        type: integer
                        format: int64
                        description: Work item ID
                      CS_CMPGUID:
                        type: string
                        maxLength: 32
                        description: GUID of WFM Runtime Component
                      CS_STAGE:
                        type: integer
                        format: int64
                        description: 'WFM: Phase in Synchronous Queue  enumValues: 01=Execution,03=Start a Combined Component,04=Start an Exception Handler,05=Error Processing,02=Result Processing'
                        enum:
                        - '01'
                        - '03'
                        - '04'
                        - '05'
                        - '02'
                      ROLL_INTERVAL:
                        type: integer
                        format: int64
                        description: Time Interval for WP Roll-Out/-In
                      ROLL_FORK_COUNT:
                        type: integer
                        format: int64
                        description: Number of Parallel Branches for WP Roll-Out/-In
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
