Help Desk

Submit a ticket My Tickets
Welcome
Login

SAP BAPI RFC Command Reference

Connector to execute remote function calls on an SAP instance.

Connections

SAP BAPI RFC

Connector to SAP RFC functions via web services.

Inputs

Input Type Detail Notes
Username TextField The user's username.
Password TextField The user's password.
Base URL TextField The base URL of the web services enabled SAP server. (e.g. https://sap.acmecorp.com)

Commands

BAPI_XBP_JOB_ADD_ABAP_STEP

Add Job Step with ABAP Program to a Job

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Count TextField The count of the job to add a step to. XML key: JOBCOUNT
Job Name TextField The name of the job. XML key: JOBNAME
Program Name TextField The name of the program
Variant Name TextField The name of the variant
SAP Username TextField The username of the SAP user that should be used

Outputs

Output Output Type Notes
Response Json
Return Json

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_JOB_JOBLOG_READ

Get the logs of a job

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Count TextField The count of the job to run. XML key: JOBCOUNT
Job Name TextField The name of the job. XML key: JOBNAME

Outputs

Output Output Type Notes
Return Json
Job Protocol Log File
Job Protocol New Log File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_JOB_OPEN

Create a job

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Class TextField The class for the new job. XML key: JOBCLASS
Job Name TextField The name of the job. XML key: JOBNAME

Outputs

Output Output Type Notes
Job Count String
Return Json
Job Name String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_JOB_READ

Read contents of the job

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Count TextField The count of the job to run. XML key: JOBCOUNT
Job Name TextField The name of the job. XML key: JOBNAME

Outputs

Output Output Type Notes
Return Json
Contents Json

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_JOB_SPOOLLIST_READ

Read the Spool List of an ABAP Job Step

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Count TextField The count of the job to run. XML key: JOBCOUNT
Job Name TextField The name of the job. XML key: JOBNAME
Step Number TextField The step number to get the spool from.

Outputs

Output Output Type Notes
Return Json
Spool Contents File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_JOB_START_IMMEDIATELY

Start a job immediately

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Count TextField The count of the job to run. XML key: JOBCOUNT
Job Name TextField The name of the job. XML key: JOBNAME
Target Group TextField The target group
Target Server TextField The target server
Run Synchronously BooleanField Run the job synchronously and wait for it to finish.

Outputs

Output Output Type Notes
Return Json
Logs File
Job Status String
Has Child String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_JOB_STATUS_GET

Get the status of a job

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Job Count TextField The count of the job to run. XML key: JOBCOUNT
Job Name TextField The name of the job. XML key: JOBNAME

Outputs

Output Output Type Notes
Return Json
Job Status String
Has Child String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XBP_REPORT_SEARCH

Search for reports

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
External Username TextField The external username to use with the request. XML key: EXTERNAL_USER_NAME
Report TextField The search string for the reports (e.g. report*) XML key: REPORT
Count NumberField The maximum number of results to return. XML key: COUNT
Report Items GroupField A list of items to add to the search. XML key: REPORTS->item

Outputs

Output Output Type Notes
Return Json
Reports Json

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XMI_LOGOFF

Log off of an external management tool

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
Interface TextField The interface (service) to log off of and end the session. XML key: INTERFACE

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

BAPI_XMI_LOGON

Log onto an external management tool

Inputs

Input Type Detail Notes
Company TextField The company to log on with. XML key: EXTCOMPANY
Product TextField The product to log on to. XML key: EXTPRODUCT
Version TextField The version of the BAPI call and service. XML key: VERSION
Interface TextField The interface (service) to log on to and create a session. XML key: INTERFACE

Outputs

Output Output Type Notes
Cookies Json
Session ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server

Generic Function Call

Call any web service enabled RFC function in your SAP environment

Inputs

Input Type Detail Notes
Cookies TextField The cookies from the initial BAPI_XMI_LOGON command.
Body XML TextField The payload of the request. Do not include the XML element for the function itself, only include the contents of that element. (e.g. Do not include <urn:BAPI_XMI_LOGON></urn:BAPI_XMI_LOGON>, but include the XML that it contains.)
Function Name TextField The name of the function (e.g. BAPI_XMI_LOGON)

Outputs

Output Output Type Notes
XML Response File
Return Json

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error Unable to authenticate with the SAP server
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.