Retrieve Job Status

Polls the environment to get the processing state for a job with a specified ID.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Required Roles

Service Administrator, Power User

Rest Resource

GET /application/rest/{api_version}/applications/{application}/jobs/{jobIdentifier}

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 15-16 Parameters

Name	Description
status	Status of the job: -1 = in progress; 0 = success; 1 = error; 2 = cancel pending; 3 = cancelled; 4 = invalid parameter; Integer.MAX_VALUE = unknown
details	Details about the job status, such as "SUCCESS" when member mappings have been processed successfully.
jobID	The ID of the job, such as 228
jobName	The name of the job, such as BESSAPP
descriptiveStatus	The status of the job, such as Completed or Error

Supported Media Types: application/json

Example of Response Body

The following is an example of the response body in JSON format that shows the job status when member mappings are exported.

{
"links": 
[
0]
"status":"0",
"details":"null",
"jobId":"1881",
"jobStatus":"SUCCESS",
"logFileName":"outbox/logs/BESSAPP-DB_1881.log",
"outputFileName":"outbox/BESSAPPJan-06.csv",
"processType":"EXPORT_MAPPING",
"executedBy":"admin"
}