GET api/Job?jobReference={jobReference}
Gets the status for a job given its reference
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| jobReference |
The job reference. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PollJobStatusDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| JobReference | globally unique identifier |
None. |
|
| JobStatus | string |
None. |
|
| JobStatusId | integer |
None. |
|
| JobPercentageCompleted | integer |
None. |
|
| JobStatusText | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"JobReference": "a450fa55-8509-4261-b6a5-7ebaffe30c40",
"JobStatus": "sample string 2",
"JobStatusId": 3,
"JobPercentageCompleted": 4,
"JobStatusText": "sample string 5"
}