openapi: 3.0.0 info: title: SAP API version: 1.0.0 servers: - url: http://localhost:8080 paths: /rfc/BAPI_XBP_JOB_READ: post: tags: - SXBP operationId: /rfc/BAPI_XBP_JOB_READ requestBody: content: application/json: schema: properties: EXTERNAL_USER_NAME: type: string maxLength: 16 description: 'XMI logging: Name of user in external management tool' JOBCOUNT: type: string maxLength: 8 description: Job ID JOBNAME: type: string maxLength: 32 description: Background job name JOB_HEADER_ONLY: type: string maxLength: 1 description: Single-character flag STEP_NUMBER: type: integer format: int32 description: Natural Number SPOOL_ATTR: type: array items: type: object properties: STEPNO: type: integer format: int32 description: Job step ID number. SPOOLID: type: integer format: int32 description: Spool request number CLIENT: type: string maxLength: 3 description: Client for which object was generated NAME: type: string maxLength: 6 description: 'Spool request: Name' SUFFIX1: type: string maxLength: 4 description: 'Spool request: Suffix 1' SUFFIX2: type: string maxLength: 12 description: 'Spool request: Suffix 2' OWNER: type: string maxLength: 12 description: User name FINAL: type: string maxLength: 1 description: Spool request completed CRTIME: type: string maxLength: 16 description: Time a spool request was created DLTIME: type: string maxLength: 16 description: Spool Request Deleted At SPOPAGES: type: integer format: int32 description: 'TemSe: Number of add protection rule' PRINTTIME: type: string maxLength: 1 description: Print immediately or later DELAFTERPRINT: type: string maxLength: 1 description: Delete spool request automatically DEVICE: type: string maxLength: 4 description: 'Spool: Output device' COPIES: type: integer format: int64 description: Number of Copies (Print Parameters) PRIORITY: type: integer format: int64 description: 'PRINT: Spool request priority' SPOFORMAT: type: string maxLength: 16 description: 'Spool: Format type' PJTOTAL: type: integer format: int32 description: 'Spool: No. output requests for spool request total' PJDONE: type: integer format: int32 description: Number of output requests processed PJPROBLEM: type: integer format: int32 description: 'Spool: Number of output requests with problems' PJERROR: type: integer format: int32 description: 'Spool: Number of output requests with errors (no printout)' WRITER: type: integer format: int32 description: 'TemSe: General counter' SPERROR: type: string maxLength: 1 description: 'Spool: Error status' TEMSENAME: type: string maxLength: 20 description: TemSe object name TEMSEPART: type: integer format: int32 description: 'TemSe: Number of the part of a TemSe object' TEMSECLIENT: type: string maxLength: 3 description: Client for which object was generated TITLE: type: string maxLength: 68 description: Title of a spool request SAPCOVER: type: string maxLength: 1 description: 'Print SAP cover page enumValues: D=Print SAP cover page as set at printer,X=Always print SAP cover page,""=Do not print SAP cover page' enum: - D - X - '' OSCOVER: type: string maxLength: 1 description: 'Print operating system cover page enumValues: ""=Do not print operating system cover page,D=Print operating system cover page as set at printer,X=Always print operating system cover page' enum: - '' - D - X RECEIVER: type: string maxLength: 12 description: 'Spool: Recipient of spool request' DIVISION: type: string maxLength: 12 description: Department AUTHORITY: type: string maxLength: 12 description: Value for authorization check MODTIME: type: string maxLength: 16 description: Last time a spool request was changed DOCTYP: type: string maxLength: 6 description: 'Spool: document type' OSNAME: type: string maxLength: 50 description: 'Spool: Long name of printers for host spooler' TMSSIZE: type: integer format: int32 description: 'TemSe: Number of bytes' TEMSELOCAT: type: string maxLength: 1 description: 'TemSe: Storage type enumValues: F=File system,D=Database,*=File system / database' enum: - F - D - '*' LINES: type: integer format: int64 description: 'Spool: Output lines of a format type' COLUMNS: type: integer format: int64 description: 'Spool: Output columns of a format type' LANGU: type: string maxLength: 1 description: Language Key CODEPAGE: type: integer format: int64 description: SAP Character Set ID TMSPARTS: type: integer format: int32 description: 'TemSe: Number of parts of a TemSe object' STEPS: type: array items: type: object properties: PROGRAM: type: string maxLength: 128 description: Program name in internal step list TYP: type: string maxLength: 1 description: Identification of step as ABAP, ext. command or program PARAMETER: type: string maxLength: 255 description: Parameters of external program (string) OPSYSTEM: type: string maxLength: 10 description: Operating System of Application Server AUTHCKNAM: type: string maxLength: 12 description: Background User Name for Authorization Check LISTIDENT: type: integer format: int64 description: ID of batch job output list in the spool XPGPID: type: string maxLength: 10 description: ID of external program XPGTGTSYS: type: string maxLength: 32 description: Target System to Run Background Job XPGRFCDEST: type: string maxLength: 32 description: Logical Destination (Specified in Function Call) LANGUAGE: type: string maxLength: 1 description: Language Key STATUS: type: string maxLength: 1 description: Status of step in background processing CONNCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) STDINCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) STDOUTCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) STDERRCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) TRACECNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) TERMCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) 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' SAP_OBJECT: type: string maxLength: 10 description: 'SAP ArchiveLink: Object type of business object' AR_OBJECT: type: string maxLength: 10 description: Document type ARCHIV_ID: type: string maxLength: 2 description: 'SAP ArchiveLink: Target storage system' DOC_TYPE: type: string maxLength: 20 description: 'SAP ArchiveLink: Document class' RPC_HOST: type: string maxLength: 32 description: SAP ArchiveLink RPC host RPC_SERVIC: type: string maxLength: 32 description: 'SAP ArchiveLink: RPC service / RFC destination' INTERFACE: type: string maxLength: 14 description: 'SAP ArchiveLink: Name of communication connection component' MANDANT: type: string maxLength: 3 description: Client REPORT: type: string maxLength: 40 description: SAP ArchiveLink Report Name INFO: type: string maxLength: 3 description: 'SAP ArchiveLink: Info field' ARCTEXT: type: string maxLength: 40 description: 'SAP ArchiveLink: Text information field' DATUM: type: string maxLength: 8 description: 'SAP ArchiveLink: Archiving date' ARCUSER: type: string maxLength: 12 description: Data element for user PRINTER: type: string maxLength: 4 description: 'SAP ArchiveLink: Specify target printer' FORMULAR: type: string maxLength: 16 description: 'SAP ArchiveLink: Output format' ARCHIVPATH: type: string maxLength: 70 description: 'SAP ArchiveLink: Standard archive path' PROTOKOLL: type: string maxLength: 8 description: 'SAP ArchiveLink: Storage connection protocol' VERSION: type: string maxLength: 4 description: 'SAP ArchiveLink: Version number enumValues: 0031=SAP ArchiveLink Interface 3.1,*=SAP ArchiveLink Interface Default Version ''*'',0045=SAP ArchiveLink HTTP Content Server Interface 4.5,0046=SAP ArchiveLink HTTP Content Server Interface 4.6' enum: - '0031' - '*' - '0045' - '0046' ACHECK: type: integer format: int32 description: 'Print: Check sum for print and archiving parameters' required: - EXTERNAL_USER_NAME - JOBCOUNT - JOBNAME responses: '200': description: OK content: application/json: schema: properties: JOBHEAD: type: object properties: JOBNAME: type: string maxLength: 32 description: Background job name JOBCOUNT: type: string maxLength: 8 description: Job ID JOBGROUP: type: string maxLength: 12 description: Summary of jobs for a group INTREPORT: type: string maxLength: 40 description: Name of internal report for batch job STEPCOUNT: type: integer format: int32 description: Job step ID number. SDLSTRTDT: type: string format: date description: Planned Start Date for Background Job SDLSTRTTM: type: string maxLength: 6 description: Planned start time for background Job BTCSYSTEM: type: string maxLength: 32 description: Target System to Run Background Job SDLDATE: type: string format: date description: Date of job/step scheduling SDLTIME: type: string maxLength: 6 description: Time of a scheduled job/step SDLUNAME: type: string maxLength: 12 description: Initiator of job/step scheduling LASTCHDATE: type: string format: date description: Date of last job change LASTCHTIME: type: string maxLength: 6 description: Time of last job change LASTCHNAME: type: string maxLength: 12 description: Last job change made by RELDATE: type: string format: date description: Release Date for Background Scheduling RELTIME: type: string maxLength: 6 description: Release time of scheduled background job RELUNAME: type: string maxLength: 12 description: User that released scheduled batch job STRTDATE: type: string format: date description: Job start date STRTTIME: type: string maxLength: 6 description: Batch job start time ENDDATE: type: string format: date description: Job start date ENDTIME: type: string maxLength: 6 description: Batch job start time PRDMINS: type: integer format: int64 description: Duration period (in minutes) for a batch job PRDHOURS: type: integer format: int64 description: Duration period (in hours) for a batch job PRDDAYS: type: integer format: int64 description: Duration (in days) of DBA action PRDWEEKS: type: integer format: int64 description: Duration period (in weeks) for a batch job PRDMONTHS: type: integer format: int64 description: Duration period (in months) for a batch job PERIODIC: type: string maxLength: 1 description: Periodic jobs indicator ('X') DELANFREP: type: string maxLength: 1 description: Job deletion indicator after processing EMERGMODE: type: string maxLength: 1 description: Emergency Job operation indicator (content 'X') STATUS: type: string maxLength: 1 description: State of Background Job NEWFLAG: type: string maxLength: 1 description: New job ID creation flag AUTHCKNAM: type: string maxLength: 12 description: Background User Name for Authorization Check AUTHCKMAN: type: string maxLength: 3 description: Background client for authorization check SUCCNUM: type: integer format: int32 description: Number of successor job(s) PREDNUM: type: integer format: int32 description: Number of previous jobs JOBLOG: type: string maxLength: 20 description: TemSe object name LASTSTRTDT: type: string format: date description: Latest Execution Date for a Background Job LASTSTRTTM: type: string maxLength: 6 description: Latest Execution Time for Background Job WPNUMBER: type: integer format: int32 description: Work process number WPPROCID: type: integer format: int32 description: Work process ID EVENTID: type: string maxLength: 32 description: Background Processing Event EVENTPARM: type: string maxLength: 64 description: Background Event Parameters (Such as, Jobname/Jobcount) BTCSYSREAX: type: string maxLength: 32 description: Target System to Run Background Job JOBCLASS: type: string maxLength: 1 description: Job classification PRIORITY: type: integer format: int32 description: Job priority EVENTCOUNT: type: string maxLength: 8 description: Event number CHECKSTAT: type: string maxLength: 1 description: Job status check indicator for subsequent job start CALENDARID: type: string maxLength: 2 description: Factory calendar ID for background processing PRDBEHAV: type: string maxLength: 1 description: Period behavior of jobs on non-workdays EXECSERVER: type: string maxLength: 20 description: Server name EOMCORRECT: type: integer format: int32 description: Correction field for calc. job execution (end-of-mth, cal.) CALCORRECT: type: integer format: int32 description: Correction field for calc. job execution (end-of-mth, cal.) REAXSERVER: type: string maxLength: 20 description: Server name RECLOGSYS: type: string maxLength: 10 description: Logical system RECOBJTYPE: type: string maxLength: 10 description: Object Type RECOBJKEY: type: string maxLength: 70 description: Object key RECDESCRIB: type: string maxLength: 10 description: Describe flag TGTSRVGRP: type: string maxLength: 40 description: Server Group Name Background Processing JOBLG_ATTR: type: object properties: TMSNAME: type: string maxLength: 20 description: TemSe object name TMSCLIENT: type: string maxLength: 3 description: Client for which object was generated CHARCO: type: integer format: int64 description: SAP Character Set ID LANGU: type: string maxLength: 1 description: Language Key TMSSIZE: type: integer format: int32 description: 'TemSe: Number of bytes' RETURN: type: object properties: TYPE: type: string maxLength: 1 description: 'Message type: S Success, E Error, W Warning, I Info, A Abort' ID: type: string maxLength: 20 description: Message Class NUMBER: type: integer format: int64 description: Message Number MESSAGE: type: string maxLength: 220 description: Message Text LOG_NO: type: string maxLength: 20 description: 'Application log: log number' LOG_MSG_NO: type: integer format: int64 description: 'Application log: Internal message serial number' MESSAGE_V1: type: string maxLength: 50 description: Message Variable MESSAGE_V2: type: string maxLength: 50 description: Message Variable MESSAGE_V3: type: string maxLength: 50 description: Message Variable MESSAGE_V4: type: string maxLength: 50 description: Message Variable PARAMETER: type: string maxLength: 32 description: Parameter Name ROW: type: integer format: int32 description: Lines in parameter FIELD: type: string maxLength: 30 description: Field in parameter SYSTEM: type: string maxLength: 10 description: Logical system from which message originates SPOOL_ATTR: type: array items: type: object properties: STEPNO: type: integer format: int32 description: Job step ID number. SPOOLID: type: integer format: int32 description: Spool request number CLIENT: type: string maxLength: 3 description: Client for which object was generated NAME: type: string maxLength: 6 description: 'Spool request: Name' SUFFIX1: type: string maxLength: 4 description: 'Spool request: Suffix 1' SUFFIX2: type: string maxLength: 12 description: 'Spool request: Suffix 2' OWNER: type: string maxLength: 12 description: User name FINAL: type: string maxLength: 1 description: Spool request completed CRTIME: type: string maxLength: 16 description: Time a spool request was created DLTIME: type: string maxLength: 16 description: Spool Request Deleted At SPOPAGES: type: integer format: int32 description: 'TemSe: Number of add protection rule' PRINTTIME: type: string maxLength: 1 description: Print immediately or later DELAFTERPRINT: type: string maxLength: 1 description: Delete spool request automatically DEVICE: type: string maxLength: 4 description: 'Spool: Output device' COPIES: type: integer format: int64 description: Number of Copies (Print Parameters) PRIORITY: type: integer format: int64 description: 'PRINT: Spool request priority' SPOFORMAT: type: string maxLength: 16 description: 'Spool: Format type' PJTOTAL: type: integer format: int32 description: 'Spool: No. output requests for spool request total' PJDONE: type: integer format: int32 description: Number of output requests processed PJPROBLEM: type: integer format: int32 description: 'Spool: Number of output requests with problems' PJERROR: type: integer format: int32 description: 'Spool: Number of output requests with errors (no printout)' WRITER: type: integer format: int32 description: 'TemSe: General counter' SPERROR: type: string maxLength: 1 description: 'Spool: Error status' TEMSENAME: type: string maxLength: 20 description: TemSe object name TEMSEPART: type: integer format: int32 description: 'TemSe: Number of the part of a TemSe object' TEMSECLIENT: type: string maxLength: 3 description: Client for which object was generated TITLE: type: string maxLength: 68 description: Title of a spool request SAPCOVER: type: string maxLength: 1 description: 'Print SAP cover page enumValues: D=Print SAP cover page as set at printer,X=Always print SAP cover page,""=Do not print SAP cover page' enum: - D - X - '' OSCOVER: type: string maxLength: 1 description: 'Print operating system cover page enumValues: ""=Do not print operating system cover page,D=Print operating system cover page as set at printer,X=Always print operating system cover page' enum: - '' - D - X RECEIVER: type: string maxLength: 12 description: 'Spool: Recipient of spool request' DIVISION: type: string maxLength: 12 description: Department AUTHORITY: type: string maxLength: 12 description: Value for authorization check MODTIME: type: string maxLength: 16 description: Last time a spool request was changed DOCTYP: type: string maxLength: 6 description: 'Spool: document type' OSNAME: type: string maxLength: 50 description: 'Spool: Long name of printers for host spooler' TMSSIZE: type: integer format: int32 description: 'TemSe: Number of bytes' TEMSELOCAT: type: string maxLength: 1 description: 'TemSe: Storage type enumValues: F=File system,D=Database,*=File system / database' enum: - F - D - '*' LINES: type: integer format: int64 description: 'Spool: Output lines of a format type' COLUMNS: type: integer format: int64 description: 'Spool: Output columns of a format type' LANGU: type: string maxLength: 1 description: Language Key CODEPAGE: type: integer format: int64 description: SAP Character Set ID TMSPARTS: type: integer format: int32 description: 'TemSe: Number of parts of a TemSe object' STEPS: type: array items: type: object properties: PROGRAM: type: string maxLength: 128 description: Program name in internal step list TYP: type: string maxLength: 1 description: Identification of step as ABAP, ext. command or program PARAMETER: type: string maxLength: 255 description: Parameters of external program (string) OPSYSTEM: type: string maxLength: 10 description: Operating System of Application Server AUTHCKNAM: type: string maxLength: 12 description: Background User Name for Authorization Check LISTIDENT: type: integer format: int64 description: ID of batch job output list in the spool XPGPID: type: string maxLength: 10 description: ID of external program XPGTGTSYS: type: string maxLength: 32 description: Target System to Run Background Job XPGRFCDEST: type: string maxLength: 32 description: Logical Destination (Specified in Function Call) LANGUAGE: type: string maxLength: 1 description: Language Key STATUS: type: string maxLength: 1 description: Status of step in background processing CONNCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) STDINCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) STDOUTCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) STDERRCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) TRACECNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) TERMCNTL: type: string maxLength: 1 description: Control flag for external program (e.g. trace level) 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' SAP_OBJECT: type: string maxLength: 10 description: 'SAP ArchiveLink: Object type of business object' AR_OBJECT: type: string maxLength: 10 description: Document type ARCHIV_ID: type: string maxLength: 2 description: 'SAP ArchiveLink: Target storage system' DOC_TYPE: type: string maxLength: 20 description: 'SAP ArchiveLink: Document class' RPC_HOST: type: string maxLength: 32 description: SAP ArchiveLink RPC host RPC_SERVIC: type: string maxLength: 32 description: 'SAP ArchiveLink: RPC service / RFC destination' INTERFACE: type: string maxLength: 14 description: 'SAP ArchiveLink: Name of communication connection component' MANDANT: type: string maxLength: 3 description: Client REPORT: type: string maxLength: 40 description: SAP ArchiveLink Report Name INFO: type: string maxLength: 3 description: 'SAP ArchiveLink: Info field' ARCTEXT: type: string maxLength: 40 description: 'SAP ArchiveLink: Text information field' DATUM: type: string maxLength: 8 description: 'SAP ArchiveLink: Archiving date' ARCUSER: type: string maxLength: 12 description: Data element for user PRINTER: type: string maxLength: 4 description: 'SAP ArchiveLink: Specify target printer' FORMULAR: type: string maxLength: 16 description: 'SAP ArchiveLink: Output format' ARCHIVPATH: type: string maxLength: 70 description: 'SAP ArchiveLink: Standard archive path' PROTOKOLL: type: string maxLength: 8 description: 'SAP ArchiveLink: Storage connection protocol' VERSION: type: string maxLength: 4 description: 'SAP ArchiveLink: Version number enumValues: 0031=SAP ArchiveLink Interface 3.1,*=SAP ArchiveLink Interface Default Version ''*'',0045=SAP ArchiveLink HTTP Content Server Interface 4.5,0046=SAP ArchiveLink HTTP Content Server Interface 4.6' enum: - '0031' - '*' - '0045' - '0046' ACHECK: type: integer format: int32 description: 'Print: Check sum for print and archiving parameters' '400': description: Bad request. 5XX: description: Unexpected error.