Getting the Status of an Asynchronous Job Using the Asynchronous Requests Management API

The Asynchronous Requests Management API can be implemented in a client application to get the status of an asynchronous job request initiated by an API.

Prerequisites

To get the status of an asynchronous job, you must have the ID of the job.

Context

An asynchronous job request initiated by an API runs as an independent process in the background. To track the progress of such job requests, you can use the Asynchronous Requests Management API. The GET /jobs/{jobId} endpoint enables you to get the current status of any asynchronous job request.

Procedure

Invoke the GET /jobs/{jobId} endpoint.
Where,
  • user, is the unique name of the user on whose behalf the API call is invoked. This is a required parameter.

  • passwordAdapter, is the password adapter for authenticating the user on whose behalf the request was initiated. This is a required parameter.

  • realm, is the SAP Ariba Contracts site to which the API request is sent. This is a required parameter.

You can append the job ID in the URL or pass it like a parameter as a path variable.

Results

If the request is successful, the API returns the status of the job request corresponding to the specified job ID along with other related details such as the submit time, start time, complete time, and the user who created the asynchronous job request. For more information about the response codes returned by the API, see Response Codes Returned by Asynchronous Job Requests API.