Get Job
/essbase/rest/v1/jobs/{id}
Returns job information for given job ID, including job status, type, and input and output information.
Request
-
id(required): string
Job ID
Response
- application/json
200 Response
OK
Job information returned successfully.
object
-
appName:
string
Application name.
-
dbName:
string
Cube name.
-
endTime:
integer(int64)
End time of the job.
-
job_ID:
integer(int64)
ID number of the job.
-
jobfileName:
string
The script file used for the job.
-
jobInputInfo:
object jobInputInfo
Additional Properties Allowed: additionalProperties
-
jobOutputInfo:
object jobOutputInfo
Additional Properties Allowed: additionalProperties
-
jobType:
string
The type of job. Examples:
dataload
,dimbuild
,calc
,clear
,importExcel
,exportExcel
,lcmExport
,lcmImport
,clearAggregation
,buildAggregation
,asoBufferDataLoad
,asoBufferCommit
,exportData
,mdxScript
. -
links:
array links
-
startTime:
integer(int64)
Start time of the job.
-
statusCode:
integer(int32)
Job status code indicating progress. Each code has a corresponding statusMessage.
statusCode statusMessage 100 IN_PROGRESS 200 COMPLETED 300 COMPLETED_WITH_WARNINGS 400 FAILED -
statusMessage:
string
Job status message string indicating progress. Each string has a corresponding statusCode.
statusCode statusMessage 100 IN_PROGRESS 200 COMPLETED 300 COMPLETED_WITH_WARNINGS 400 FAILED -
userName:
string
User who ran the job. Users have access to job listings based on their assigned user role. For example, if you have the Service Administrator role, you can see all jobs; if you have the User role, you can see only the jobs you ran.
object
object
500 Response
Internal Server Error.
503 Response
Service Unavailable
Naming exception or server exception.
Examples
The following example shows how to get job information for given job ID.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat
.
Script with cURL Command
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/jobs/1534" -H "accept: application/json" -u %User%:%Password%
Example of Response Body
{
"job_ID": 1534,
"appName": "ASOSamp",
"dbName": "Basic",
"jobType": "Import Excel",
"jobfileName": "ASO_Sample.xlsx",
"userName": "power1",
"startTime": 1574811654000,
"endTime": 1574811688000,
"statusCode": 200,
"statusMessage": "Completed",
"jobInputInfo": {
"catalogExcelPath": "/gallery/Applications/Demo Samples/Aggregate Storage/",
"importExcelFileName": "ASO_Sample.xlsx",
"isLoadData": false,
"recreateApplication": true,
"isCreateFiles": true,
"isExecuteScript": false
},
"jobOutputInfo": {
"errorMessage": ""
},
"links": [
{
"rel": "self",
"href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/1534",
"method": "GET"
},
{
"rel": "post",
"href": "https://myserver.example.com:9001/essbase/rest/v1/jobs/1534",
"method": "POST"
}
]
}