openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/IO_C_CHECK_OUT_PREPARE:
    post:
      tags:
      - SI61
      operationId: /rfc/IO_C_CHECK_OUT_PREPARE
      requestBody:
        content:
          application/json:
            schema:
              properties:
                LOCAL_WORKFLOW:
                  type: string
                  maxLength: 1
                  description: Single-Character Flag
                SUPPRESS_AUTHORITY_CHECK:
                  type: string
                  default: X
                  maxLength: 1
                SUPPRESS_OBJS_NOT_TO_BE_TRANSL:
                  type: string
                  default: X
                  maxLength: 1
                SUPPRESS_PREVIOUS_TRANSL:
                  type: string
                  default: X
                  maxLength: 1
                TASK_FOR_ADDED_IOS:
                  type: string
                  default: ATTR
                  maxLength: 10
                TRADOS_TRANSL_WORKFLOW:
                  type: string
                  maxLength: 1
                  description: Single-Character Flag
                BAD_OBJECTS:
                  type: array
                  items:
                    type: object
                    properties:
                      CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      OBJID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      ID:
                        type: string
                        maxLength: 20
                        description: Message Class
                      TYPE:
                        type: string
                        maxLength: 1
                        description: Message Type
                      'NO':
                        type: integer
                        format: int64
                        description: Message Number
                      V1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                CHECK_OUT_LIST:
                  type: array
                  items:
                    type: object
                    properties:
                      TASK:
                        type: string
                        maxLength: 10
                        description: Task to be executed with log./phys. document
                      CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      OBJID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                CONTEXT:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        maxLength: 25
                        description: Attribute of a document or a relationship
                      VALUE:
                        type: string
                        maxLength: 64
                        description: Attribute Value
                RESULT:
                  type: array
                  items:
                    type: object
                    properties:
                      LO_CLASS:
                        type: string
                        maxLength: 10
                        description: Class of logical document
                      LOIO_ID:
                        type: string
                        maxLength: 32
                        description: Logical document
                      TASK_NAME:
                        type: string
                        maxLength: 10
                        description: Task to be executed with log./phys. document
                      START_FLG:
                        type: string
                        maxLength: 1
                        description: 'Start flag for immediate execution of task  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                      FA_CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      FAIO_ID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      PH_CLASS:
                        type: string
                        maxLength: 10
                        description: Physical document class
                      PHIO_ID:
                        type: string
                        maxLength: 32
                        description: Physical document
                      PHIO_ROLE:
                        type: string
                        maxLength: 10
                        description: Role of object in task
                      COUT_MODE:
                        type: string
                        maxLength: 1
                        description: 'KPro: check-out mode for PHIO edit/readonly/only meta data  enumValues: 0=Only transfer properties to client (no content),2=Actual check-out of physical info object,1=Transfer copy of physical info object to client'
                        enum:
                        - '0'
                        - '2'
                        - '1'
                      OPEN_FLG:
                        type: string
                        maxLength: 1
                        description: 'Flag for indicating documents to be opened  enumValues: ""=No,X=Yes'
                        enum:
                        - ''
                        - X
                TRANSLATION_PREP:
                  type: array
                  items:
                    type: object
                    properties:
                      LOIO_CLASS:
                        type: string
                        maxLength: 10
                        description: Document class
                      LOIO_ID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      CURRSRC_CL:
                        type: string
                        maxLength: 10
                        description: Document class
                      CURRSRC_ID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      PREVDST_CL:
                        type: string
                        maxLength: 10
                        description: Document class
                      PREVDST_ID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      PREVSRC_CL:
                        type: string
                        maxLength: 10
                        description: Document class
                      PREVSRC_ID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      CURRDST_CL:
                        type: string
                        maxLength: 10
                        description: Document class
                      CURRDST_ID:
                        type: string
                        maxLength: 32
                        description: ID for documents and relations
                      TASK:
                        type: string
                        maxLength: 10
                        description: Task to be executed with log./phys. document
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  ERROR_MSG:
                    type: object
                    properties:
                      ID:
                        type: string
                        maxLength: 20
                        description: Message Class
                      TYPE:
                        type: string
                        maxLength: 1
                        description: Message Type
                      'NO':
                        type: integer
                        format: int64
                        description: Message Number
                      V1:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V2:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V3:
                        type: string
                        maxLength: 50
                        description: Message Variable
                      V4:
                        type: string
                        maxLength: 50
                        description: Message Variable
                  BAD_OBJECTS:
                    type: array
                    items:
                      type: object
                      properties:
                        CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        OBJID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        ID:
                          type: string
                          maxLength: 20
                          description: Message Class
                        TYPE:
                          type: string
                          maxLength: 1
                          description: Message Type
                        'NO':
                          type: integer
                          format: int64
                          description: Message Number
                        V1:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        V2:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        V3:
                          type: string
                          maxLength: 50
                          description: Message Variable
                        V4:
                          type: string
                          maxLength: 50
                          description: Message Variable
                  CHECK_OUT_LIST:
                    type: array
                    items:
                      type: object
                      properties:
                        TASK:
                          type: string
                          maxLength: 10
                          description: Task to be executed with log./phys. document
                        CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        OBJID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                  CONTEXT:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 25
                          description: Attribute of a document or a relationship
                        VALUE:
                          type: string
                          maxLength: 64
                          description: Attribute Value
                  RESULT:
                    type: array
                    items:
                      type: object
                      properties:
                        LO_CLASS:
                          type: string
                          maxLength: 10
                          description: Class of logical document
                        LOIO_ID:
                          type: string
                          maxLength: 32
                          description: Logical document
                        TASK_NAME:
                          type: string
                          maxLength: 10
                          description: Task to be executed with log./phys. document
                        START_FLG:
                          type: string
                          maxLength: 1
                          description: 'Start flag for immediate execution of task  enumValues: ""=No,X=Yes'
                          enum:
                          - ''
                          - X
                        FA_CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        FAIO_ID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        PH_CLASS:
                          type: string
                          maxLength: 10
                          description: Physical document class
                        PHIO_ID:
                          type: string
                          maxLength: 32
                          description: Physical document
                        PHIO_ROLE:
                          type: string
                          maxLength: 10
                          description: Role of object in task
                        COUT_MODE:
                          type: string
                          maxLength: 1
                          description: 'KPro: check-out mode for PHIO edit/readonly/only meta data  enumValues: 0=Only transfer properties to client (no content),2=Actual check-out of physical info object,1=Transfer copy of physical info object to client'
                          enum:
                          - '0'
                          - '2'
                          - '1'
                        OPEN_FLG:
                          type: string
                          maxLength: 1
                          description: 'Flag for indicating documents to be opened  enumValues: ""=No,X=Yes'
                          enum:
                          - ''
                          - X
                  TRANSLATION_PREP:
                    type: array
                    items:
                      type: object
                      properties:
                        LOIO_CLASS:
                          type: string
                          maxLength: 10
                          description: Document class
                        LOIO_ID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        CURRSRC_CL:
                          type: string
                          maxLength: 10
                          description: Document class
                        CURRSRC_ID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        PREVDST_CL:
                          type: string
                          maxLength: 10
                          description: Document class
                        PREVDST_ID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        PREVSRC_CL:
                          type: string
                          maxLength: 10
                          description: Document class
                        PREVSRC_ID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        CURRDST_CL:
                          type: string
                          maxLength: 10
                          description: Document class
                        CURRDST_ID:
                          type: string
                          maxLength: 32
                          description: ID for documents and relations
                        TASK:
                          type: string
                          maxLength: 10
                          description: Task to be executed with log./phys. document
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
