Retrieve Job Status

Use this REST API to poll the server 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

REST Resource

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

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-40 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 8-41 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 "Metadata import was successful" for metadata import
jobID	The ID of the job, such as 224
jobName	The name of the job, such as Refresh Database
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 for metadata import:

{
    "status": 0,
    "details": "Metadata import was successful",
    "jobId": 224,
    "jobName": "Import Account Metadata",
    "descriptiveStatus": "Completed",
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/test2/jobs/224",
        "action": "GET"
    }, {
        "rel": "job-details",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/test2/jobs/224/details",
        "action": "GET"
    }]
}
The following shows an example of the response body when an error occurs during cube refresh:
{
   "status": 1,
    "details": "An error occurred while updating the relational database.",
    "jobStatus": "Error",
    "jobId": 145,
    "jobName": "Refresh Database",
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/jobs/145",
        "action": "GET"
    }}, {
        "rel": "job-details",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/test2/jobs/145/details",
        "action": "GET"
    }]
}

The following shows an example of the response body when an error occurs during cube refresh:

{
   "status": 1,
    "details": "An error occurred while updating the relational database.",
    "jobStatus": "Error",
    "jobId": 145,
    "jobName": "Refresh Database",
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/jobs/145",
        "action": "GET"
    }}, {
        "rel": "job-details",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/test2/jobs/145/details",
        "action": "GET"
    }]
}