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 16-9 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None
applicationName	The name of the application	Path	Yes	None
jobIdentifier	The ID of the job	Path	Yes	None

Response

Parameters

The following table summarizes the response parameters.

Table 16-10 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 a batch has processed successfully.
jobID	The ID of the job, such as 226
jobName	The name of the job, such as BATCH1
descriptiveStatus	The status of the job, such as Completed or Error

Supported Media Types: application/json

Example of Response Body

The following shows an example of the response body in JSON format when a batch is run.

{
"jobStatus": "SUCCESS",
"jobId": 2024,
"logFileName": "\outbox\logs\BATCH1_7595.log",
"outputFileName": null,
"processType": "COMM_BATCH",
"executedBy": "admin",
"status": -1,
"links": [1],
    0:  {
    "rel": "self",
    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/aif/rest/V1/jobs/2024,
    "action": "GET"
}
"details": null
}