GET api/Job?jobReference={jobReference}
Gets the status for a job given its reference Processes this job API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| jobReference |
The job reference. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
PollJobStatusDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| JobReference |
The job reference globally unique identifier. |
globally unique identifier |
None. |
| JobStatus |
The job status value. |
string |
None. |
| JobStatusId |
The unique identifier of the related job status resource. |
integer |
None. |
| JobPercentageCompleted |
The job percentage completed value. |
integer |
None. |
| JobStatusText |
The job status text value. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"JobReference": "417c7948-6217-45c2-b3c3-84c58dc608c3",
"JobStatus": "sample string 2",
"JobStatusId": 3,
"JobPercentageCompleted": 4,
"JobStatusText": "sample string 5"
}