Downloading the Error File of a Failed Job Request Using the Asynchronous Requests Management API

The Asynchronous Requests Management API can be implemented in a client application to download the error file for a failed job request.

Prerequisites

To download the error file for a failed job request, you must have the ID of the job.

Context

The GET /jobs/{jobId}/errors endpoint of the Asynchronous Requests Management API enables you to download the error file of a failed job request. You can download the error file in the available file format.

Procedure

Invoke the GET /jobs/{jobId}/errors 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, one of the following occurs:

  • If the response code is 200, the API returns the error file in the available file format, which specifies the reason for the incomplete job request.

  • If the response code is 204, the API doesn't return any error file, which indicates that either the job request was successfully completed or there is no error file associated with the specified job ID.

If the request is unsuccessful, the API returns a appropriate response code. For more information about the different response codes returned by the API, see Response Codes Returned by Asynchronous Job Requests API.