Job Status

Request information about a job, including current progress.

Only available to hosted SaaS clients

HTTP Request

GET /icweb.dll/jobStatus?id={Id}

URI Parameters

Name	In	Required	Type	Description
id	Path	Yes	String	Specifies the job to retrieve the serverJob object for, containing the current progress.

Responses

Name	Type	Description
200 OK	serverJob	OK
404 Not Found	String	Job identified by id was not found.

Server Job

The Server Job object, contains information about the import job that was just started.

Name	Type	Description	Optional
id	string	Unique Identifier for this import job, can be used to request updated information on status.	No
percentComplete	integer	0 - 100 percent complete of rows in import job.	Yes
summary	string	Contains a summary of the import job, thus far.	Yes
status	integer	Current status of the job, 1 = Waiting to Start, 2 = Starting, 3 = Running, 4 = Completed, 5 = Failed, 6 = Paused	No

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?id={FAAF7FBC-0475-45ED-A148-02238E75C395}

Response

{
        "id": "{FAAF7FBC-0475-45ED-A148-02238E75C395}",
        "percentComplete": 35,
        "summary": "",
        "status": 3
}

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={id}

URI Parameters

Name	In	Required	Type	Description
id	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"
                                        }
                                ]
                        }
                }
        ]
}