openapi: 3.0.0
info:
  title: SAP API
  version: 1.0.0
servers:
- url: http://localhost:8080
paths:
  /rfc/SUBST_START_BATCHJOB:
    post:
      tags:
      - SUGI
      summary: RFC-Enabled FM for Starting a Background Job
      operationId: /rfc/SUBST_START_BATCHJOB
      requestBody:
        content:
          application/json:
            schema:
              properties:
                AUTHCKNAM:
                  type: string
                  default: DDIC
                  maxLength: 12
                  description: Name of user under whom report runs
                BATCHHOST:
                  type: string
                  default: ' '
                  maxLength: 32
                  description: Name of addressed host (see source text!)
                IV_ABORT_ON_ERROR:
                  type: string
                  default: ' '
                  maxLength: 1
                IV_SCHEDEVER:
                  type: string
                  default: ' '
                  maxLength: 1
                  description: Flag:'X'=Start even for BATCHHOST without batch capacity
                JOBNAME:
                  type: string
                  default: ' '
                  maxLength: 32
                  description: Name of background job that will be started
                LANGUAGE:
                  type: string
                  default: SY-LANGU
                  maxLength: 1
                  description: Language in which job should run
                PRIPARAMS:
                  type: object
                  properties:
                    PDEST:
                      type: string
                      maxLength: 4
                      description: Output Device (Print Parameters)
                    PRCOP:
                      type: integer
                      format: int64
                      description: Number of Copies (Print Parameters)
                    PLIST:
                      type: string
                      maxLength: 12
                      description: Name of Spool Request (Print Parameters)
                    PRTXT:
                      type: string
                      maxLength: 68
                      description: Text for Cover Page (Print Parameters)
                    PRIMM:
                      type: string
                      maxLength: 1
                      description: Print Immediately (Print Parameters)
                    PRREL:
                      type: string
                      maxLength: 1
                      description: Delete After Printing (Print Parameters)
                    PRNEW:
                      type: string
                      maxLength: 1
                      description: New Spool Request (Print Parameters)
                    PEXPI:
                      type: integer
                      format: int64
                      description: Spool Retention Period (Print Parameters)
                    LINCT:
                      type: integer
                      format: int32
                      description: Page Length of List
                    LINSZ:
                      type: integer
                      format: int32
                      description: Line width of list
                    PAART:
                      type: string
                      maxLength: 16
                      description: Print Format (Print Parameters)
                    PRBIG:
                      type: string
                      maxLength: 1
                      description: Selection Cover Page (Print Parameters)
                    PRSAP:
                      type: string
                      maxLength: 1
                      description: 'Print: SAP cover page  enumValues: X=Print,""=Do Not Print,D=Default (Printer Setting)'
                      enum:
                      - X
                      - ''
                      - D
                    PRREC:
                      type: string
                      maxLength: 12
                      description: Recipient (Print Parameters)
                    PRABT:
                      type: string
                      maxLength: 12
                      description: Department on Cover Page (Print Parameters)
                    PRBER:
                      type: string
                      maxLength: 12
                      description: 'Print: Authorization'
                    PRDSN:
                      type: string
                      maxLength: 6
                      description: Name of Spool File
                    PTYPE:
                      type: string
                      maxLength: 12
                      description: 'Print: Type of spool request'
                    ARMOD:
                      type: string
                      maxLength: 1
                      description: 'Print: Archiving mode  enumValues: 1=Print only,2=Archive only,3=Print and archive'
                      enum:
                      - '1'
                      - '2'
                      - '3'
                    FOOTL:
                      type: string
                      maxLength: 1
                      description: 'Print: Output footer'
                    PRIOT:
                      type: integer
                      format: int64
                      description: 'PRINT: Spool request priority'
                    PRUNX:
                      type: string
                      maxLength: 1
                      description: 'PRINT: Host spool cover page  enumValues: X=Print,""=Do Not Print,D=Default (Printer Setting)'
                      enum:
                      - X
                      - ''
                      - D
                    PRKEYEXT:
                      type: string
                      maxLength: 16
                      description: Key for print parameters
                    PRCHK:
                      type: integer
                      format: int32
                      description: 'Print: Check sum for print and archiving parameters'
                REPNAME:
                  type: string
                  default: ' '
                  maxLength: 40
                  description: Name of report that will be started
                VARNAME:
                  type: string
                  default: ' '
                  maxLength: 14
                  description: Name of variant for this report
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  JOBCOUNT:
                    type: string
                    maxLength: 8
                    description: Job Number
                  RC_START:
                    type: integer
                    format: int32
                    description: Return code (if IV_ABORT_ON_ERROR = SPACE)
        '400':
          description: Bad request.
        5XX:
          description: Unexpected error.
