openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/SO_SMALL_DOCUMENT_RECEIVE_API1:
    post:
      tags:
      - SOI1
      summary: 'SAPoffice: Receive documents from another mail system'
      operationId: /rfc/SO_SMALL_DOCUMENT_RECEIVE_API1
      requestBody:
        content:
          application/json:
            schema:
              properties:
                DOCUMENT_DATA:
                  type: object
                  properties:
                    OBJ_NAME:
                      type: string
                      maxLength: 12
                      description: Name of document, folder or distribution list
                    OBJ_DESCR:
                      type: string
                      maxLength: 50
                      description: Short description of contents
                    OBJ_LANGU:
                      type: string
                      maxLength: 1
                      description: Language in Which Document Is Created
                    OBJ_SORT:
                      type: string
                      maxLength: 10
                      description: Sort field
                    OBJ_EXPDAT:
                      type: string
                      format: date
                      description: Expiration date of object
                    SENSITIVTY:
                      type: string
                      maxLength: 1
                      description: 'Object: Sensitivity (private, functional, ...)  enumValues: F=Functional,O=Standard,P=Confidential'
                      enum:
                      - F
                      - O
                      - P
                    OBJ_PRIO:
                      type: string
                      maxLength: 1
                      description: 'Document priority  enumValues: 8=,9=Lowest priority,1=Highest priority'
                      enum:
                      - '8'
                      - '9'
                      - '1'
                    NO_CHANGE:
                      type: string
                      maxLength: 1
                      description: 'Document cannot be changed  enumValues: X=Value for activated,""=Value for deactivated'
                      enum:
                      - X
                      - ''
                    PRIORITY:
                      type: string
                      maxLength: 1
                      description: 'Priority  enumValues: 8=,9=Lowest priority,1=Highest priority'
                      enum:
                      - '8'
                      - '9'
                      - '1'
                    EXPIRY_DAT:
                      type: string
                      format: date
                      description: 'SAPoffice: Expiration Date for this Folder Entry'
                    PROC_TYPE:
                      type: string
                      maxLength: 1
                      description: 'Execute: Type (Report, Dialog Module, ...)'
                    PROC_NAME:
                      type: string
                      maxLength: 30
                      description: 'SAPoffice: Text field'
                    PROC_SYST:
                      type: string
                      maxLength: 10
                      description: System in which the document is processed
                    PROC_CLINT:
                      type: string
                      maxLength: 3
                      description: Client in which document is processed
                    SKIP_SCREN:
                      type: string
                      maxLength: 1
                      description: 'Execute: Process First Screen in Background  enumValues: X=Value for activated,""=Value for deactivated'
                      enum:
                      - X
                      - ''
                    TO_DO_OUT:
                      type: string
                      maxLength: 1
                      description: 'ToDo: To Be Completed Outside SAPoffice  enumValues: X=Value for activated,""=Value for deactivated'
                      enum:
                      - X
                      - ''
                    FREE_DEL:
                      type: string
                      maxLength: 1
                      description: 'Object Can Be Deleted by All Users with an Application  enumValues: X=Value for activated,""=Value for deactivated'
                      enum:
                      - X
                      - ''
                    DOC_SIZE:
                      type: string
                      maxLength: 12
                      description: Size of SAPoffice Document (for API1)
                DOCUMENT_TYPE:
                  type: string
                  maxLength: 3
                  description: Document type
                RECEIVE_INFO:
                  type: object
                  properties:
                    COMM_ID:
                      type: string
                      maxLength: 964
                      description: Communications ID for this external send operation
                    SENDER:
                      type: string
                      maxLength: 1215
                      description: Sender of an external document
                    ADR_TYPE:
                      type: string
                      maxLength: 4
                      description: 'SAPoffice: type of address'
                    REPLY_TO:
                      type: string
                      maxLength: 964
                      description: Communic.ID to which the external document is a reply
                    SEND_DATE:
                      type: string
                      format: date
                      description: Date On Which Object Was Sent
                    SEND_TIME:
                      type: string
                      maxLength: 6
                      description: Time at Which The Object Was Sent
                    CREAT_DATE:
                      type: string
                      format: date
                      description: 'SAPoffice: Date when object/user was created'
                    CREAT_TIME:
                      type: string
                      maxLength: 6
                      description: 'SAPoffice: Time when object/user was created'
                CONTENTS_HEX:
                  type: array
                  items:
                    type: object
                    properties:
                      LINE:
                        type: string
                        format: byte
                        description: 'SAPoffice: Binary data, length 255'
                OBJECT_CONTENT:
                  type: array
                  items:
                    type: object
                    properties:
                      LINE:
                        type: string
                        maxLength: 255
                        description: 'Text field length 255: texts'
                OBJECT_HEADER:
                  type: array
                  items:
                    type: object
                    properties:
                      LINE:
                        type: string
                        maxLength: 255
                        description: 'Text field length 255: texts'
                OBJECT_PARA:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        maxLength: 8
                        description: CHAR08 data element for SYST
                      OPTION:
                        type: string
                        maxLength: 4
                        description: CHAR04 data element for SYST
                      LOW:
                        type: string
                        maxLength: 40
                        description: CHAR40 for SYST
                      HIGH:
                        type: string
                        maxLength: 40
                        description: CHAR40 for SYST
                OBJECT_PARB:
                  type: array
                  items:
                    type: object
                    properties:
                      NAME:
                        type: string
                        maxLength: 30
                        description: 'SAPoffice: name of the parameter value'
                      VALUE:
                        type: string
                        maxLength: 255
                        description: 'Text field length 255: texts'
                RECEIVERS:
                  type: array
                  items:
                    type: object
                    properties:
                      RECEIVER:
                        type: string
                        maxLength: 1215
                        description: External address (SMTP/X.400...)
                      ADR_TYP:
                        type: string
                        maxLength: 4
                        description: 'SAPoffice: type of address'
                      COPY_LIST:
                        type: string
                        maxLength: 1
                        description: 'Appears in the recipient list as a recipient  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      EXPRESS:
                        type: string
                        maxLength: 1
                        description: 'Send express  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      COPY:
                        type: string
                        maxLength: 1
                        description: 'Send: As copy  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      BLIND_COPY:
                        type: string
                        maxLength: 1
                        description: 'Send as a blind copy  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      NO_FORWARD:
                        type: string
                        maxLength: 1
                        description: 'You cannot forward this message  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      NO_PRINT:
                        type: string
                        maxLength: 1
                        description: 'Object cannot be printed  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      TO_ANSWER:
                        type: string
                        maxLength: 1
                        description: 'A reply must be sent for this object  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      TO_DO_EXPL:
                        type: string
                        maxLength: 1
                        description: 'ToDo by all recipients  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      TO_DO_GRP:
                        type: string
                        maxLength: 1
                        description: ToDo group of the recipient
                      COM_TYPE:
                        type: string
                        maxLength: 6
                        description: 'Transmission Method (Fax, Telex, ...)  enumValues: ""=SAPoffice internal,TELEX=Telex,TELFAX=Fax'
                        enum:
                        - ''
                        - TELEX
                        - TELFAX
                      LFDNR:
                        type: string
                        maxLength: 3
                        description: 'Addresses: Sequence Number of Address'
                      FAX:
                        type: string
                        maxLength: 30
                        description: 'SAPoffice: Fax number'
                      COUNTRY:
                        type: string
                        maxLength: 3
                        description: Country Key
                      SPOOL_ID:
                        type: string
                        maxLength: 5
                        description: ID of the spool entry (e.g. after faxing)
                      NOTIF_DEL:
                        type: string
                        maxLength: 1
                        description: 'Acknowledgment of receipt expected  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      NOTIF_READ:
                        type: string
                        maxLength: 1
                        description: Read acknowledgment expected
                      NOTIF_NDEL:
                        type: string
                        maxLength: 1
                        description: 'Acknowledgment of receipt expected  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      SAP_BODY:
                        type: string
                        maxLength: 1
                        description: 'Send externally with SAP data part  enumValues: X=Value for activated,""=Value for deactivated'
                        enum:
                        - X
                        - ''
                      REC_DATE:
                        type: string
                        format: date
                        description: Date document was received
                      RETRN_CODE:
                        type: string
                        maxLength: 4
                        description: Return code
              required:
              - DOCUMENT_DATA
              - DOCUMENT_TYPE
              - RECEIVE_INFO
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  COMMUNICATION_ID:
                    type: string
                    maxLength: 964
                    description: Send operation ID
                  NEW_OBJECT_ID:
                    type: string
                    maxLength: 17
                    description: Object ID of created document
                  SENT_TO_ALL:
                    type: string
                    maxLength: 1
                    description: 'Flag: Document was sent to all'
                  CONTENTS_HEX:
                    type: array
                    items:
                      type: object
                      properties:
                        LINE:
                          type: string
                          format: byte
                          description: 'SAPoffice: Binary data, length 255'
                  OBJECT_CONTENT:
                    type: array
                    items:
                      type: object
                      properties:
                        LINE:
                          type: string
                          maxLength: 255
                          description: 'Text field length 255: texts'
                  OBJECT_HEADER:
                    type: array
                    items:
                      type: object
                      properties:
                        LINE:
                          type: string
                          maxLength: 255
                          description: 'Text field length 255: texts'
                  OBJECT_PARA:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 8
                          description: CHAR08 data element for SYST
                        OPTION:
                          type: string
                          maxLength: 4
                          description: CHAR04 data element for SYST
                        LOW:
                          type: string
                          maxLength: 40
                          description: CHAR40 for SYST
                        HIGH:
                          type: string
                          maxLength: 40
                          description: CHAR40 for SYST
                  OBJECT_PARB:
                    type: array
                    items:
                      type: object
                      properties:
                        NAME:
                          type: string
                          maxLength: 30
                          description: 'SAPoffice: name of the parameter value'
                        VALUE:
                          type: string
                          maxLength: 255
                          description: 'Text field length 255: texts'
                  RECEIVERS:
                    type: array
                    items:
                      type: object
                      properties:
                        RECEIVER:
                          type: string
                          maxLength: 1215
                          description: External address (SMTP/X.400...)
                        ADR_TYP:
                          type: string
                          maxLength: 4
                          description: 'SAPoffice: type of address'
                        COPY_LIST:
                          type: string
                          maxLength: 1
                          description: 'Appears in the recipient list as a recipient  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        EXPRESS:
                          type: string
                          maxLength: 1
                          description: 'Send express  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        COPY:
                          type: string
                          maxLength: 1
                          description: 'Send: As copy  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        BLIND_COPY:
                          type: string
                          maxLength: 1
                          description: 'Send as a blind copy  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        NO_FORWARD:
                          type: string
                          maxLength: 1
                          description: 'You cannot forward this message  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        NO_PRINT:
                          type: string
                          maxLength: 1
                          description: 'Object cannot be printed  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        TO_ANSWER:
                          type: string
                          maxLength: 1
                          description: 'A reply must be sent for this object  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        TO_DO_EXPL:
                          type: string
                          maxLength: 1
                          description: 'ToDo by all recipients  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        TO_DO_GRP:
                          type: string
                          maxLength: 1
                          description: ToDo group of the recipient
                        COM_TYPE:
                          type: string
                          maxLength: 6
                          description: 'Transmission Method (Fax, Telex, ...)  enumValues: ""=SAPoffice internal,TELEX=Telex,TELFAX=Fax'
                          enum:
                          - ''
                          - TELEX
                          - TELFAX
                        LFDNR:
                          type: string
                          maxLength: 3
                          description: 'Addresses: Sequence Number of Address'
                        FAX:
                          type: string
                          maxLength: 30
                          description: 'SAPoffice: Fax number'
                        COUNTRY:
                          type: string
                          maxLength: 3
                          description: Country Key
                        SPOOL_ID:
                          type: string
                          maxLength: 5
                          description: ID of the spool entry (e.g. after faxing)
                        NOTIF_DEL:
                          type: string
                          maxLength: 1
                          description: 'Acknowledgment of receipt expected  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        NOTIF_READ:
                          type: string
                          maxLength: 1
                          description: Read acknowledgment expected
                        NOTIF_NDEL:
                          type: string
                          maxLength: 1
                          description: 'Acknowledgment of receipt expected  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        SAP_BODY:
                          type: string
                          maxLength: 1
                          description: 'Send externally with SAP data part  enumValues: X=Value for activated,""=Value for deactivated'
                          enum:
                          - X
                          - ''
                        REC_DATE:
                          type: string
                          format: date
                          description: Date document was received
                        RETRN_CODE:
                          type: string
                          maxLength: 4
                          description: Return code
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
