Job Status¶
Request information about a job, including current progress. If no id is supplied a list of all jobs for the user are returned.
Only available to hosted SaaS clients
HTTP Request¶
GET /icweb.dll/jobStatus/{Id}
URI Parameters¶
Name |
In |
Required |
Type |
Description |
|
Path |
No |
String |
Specifies the job to retrieve the serverJob object for, containing the current progress. |
Responses¶
Name |
Type |
Description |
200 OK |
serverJob |
When an individual job is requested. |
200 OK |
When all jobs are requested. |
|
404 Not Found |
String |
Job identified by id was not found. |
Server Jobs¶
The Server Jobs object, contains information about the jobs the user has initiated.
Name |
Type |
Description |
Optional |
|
serverJob [] |
An array of jobs that are associated with the current user. |
No |
Server Job¶
The Server Job object, contains information about the job that was specified.
Name |
Type |
Description |
Optional |
Default |
|
string |
Unique Identifier for this job, can be used to request updated information on status. |
No |
|
|
integer |
0 - 100 percent complete of the job. |
Yes |
0 |
|
string |
Contains a summary of the job, thus far. |
Yes |
Unavailable |
|
integer |
Current status of the job, 1 = Waiting to Start, 2 = Starting, 3 = Running, 4 = Completed, 5 = Failed, 6 = Paused |
No |
|
|
String |
Date and time the job started. |
Yes |
False |
|
String |
Date and time the job finished. |
Yes |
False |
|
bool |
Has this job been dismissed by the user. |
Yes |
False |
|
bool |
Can this job be dismissed? |
Yes |
False |
Note under some circumstances, the percentComplete value returned may exceed 100. This is caused by NEXUS underestimating the total row count at the commencement of the generation job.
Example¶
Retrieve the job status, with the id of ‘{FAAF7FBC-0475-45ED-A148-02238E75C395}’.
Request¶
GET /icweb.dll/jobStatus/{FAAF7FBC-0475-45ED-A148-02238E75C395}
Response¶
{
"id": "{FAAF7FBC-0475-45ED-A148-02238E75C395}",
"percentComplete": 35,
"summary": "",
"status": 3
}
Example¶
Retrieve all jobs the user has initiated.
Request¶
GET /icweb.dll/jobStatus
Response¶
{
"jobs": [{
"id": "{DD89258A-F8FD-4629-9B7E-569EDA31387E}",
"percentComplete": 100,
"status": 4
}, {
"id": "{D561361F-FD3A-492A-AE35-B6B77B28B2E0}",
"percentComplete": 100,
"status": 4
}
]
}
Job Dismiss¶
Dismiss a job so that it is no longer showon in the UI of NEXUS IC or IC-Web.
Only available to hosted SaaS clients
HTTP Request¶
GET /icweb.dll/jobDismiss/{Id}
URI Parameters¶
Name |
In |
Required |
Type |
Description |
|
Path |
Yes |
String |
Specifies the job dismiss. |
Responses¶
Name |
Type |
Description |
200 OK |
Job was successfully dismissed. |
|
403 Forbidden |
Job is not able to be dismissed. |
|
404 Not Found |
String |
Job identified by id was not found. |
Job Content¶
Request the content from a completed job, some jobs may not provide any content.
Only available to hosted SaaS clients
HTTP Request¶
GET /icweb.dll/jobContent/{id}
URI Parameters¶
Name |
In |
Required |
Type |
Description |
|
Path |
Yes |
String |
Specifies the job to retrieve the content for. The content will be returned, pay important attention to the response type. |
Responses¶
Name |
Type |
Description |
200 OK |
Binary / Text - see mime type of response. |
OK |
404 Not Found |
String |
Job identified by id was not found. |
Example¶
Retrieve the job content, with the id of ‘{FAAF7FBC-0475-45ED-A148-02238E75C395}’.
Request¶
GET /icweb.dll/jobContent?id={FAAF7FBC-0475-45ED-A148-02238E75C395}
Response¶
content-type: application/json
content-disposition: attachment;filename="report.json"
{
"elements": [{
"type": "table",
"caption": "Table of Data",
"data": {
"sourceBusinessObject": "Task",
"columns": [{
"caption": "Asset"
}, {
"caption": "Event Type"
}, {
"caption": "Workpack"
}
],
"rows": [{
"sourceKey": 1,
"cells": [{
"value": "Test Asset"
}, {
"value": "GVI"
}, {
"value": "Workpack A"
}
]
}, {
"sourceKey": 2,
"cells": [{
"value": "Test Asset"
}, {
"value": "GVI"
}, {
"value": "Workpack B"
}
]
}
]
}
}, {
"type": "paragraph",
"data": {
"text": [{
"value": "Report generated in 00:00:01"
}
]
}
}
]
}