GET api/job/instance/{jobInstanceID}
Get a Job Instance by ID (this will contain the JobDefinitionID).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| jobInstanceID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
JobInstance| Name | Description | Type | Additional information |
|---|---|---|---|
| JobInstanceID | integer |
None. |
|
| JobDefinitionID | integer |
None. |
|
| Status | JobInstanceStatus |
None. |
|
| JobType | JobType |
None. |
|
| JobInput | string |
None. |
|
| JobOutput | string |
None. |
|
| AgentID | globally unique identifier |
None. |
|
| NotificationChannelID | integer |
None. |
|
| StartTime | date |
None. |
|
| EndTime | date |
None. |
|
| TotalItemCount | integer |
None. |
|
| CompletedItemCount | integer |
None. |
|
| rowver | Collection of byte |
None. |
Response Formats
application/json, text/json
Sample:
{
"JobInstanceID": 1,
"JobDefinitionID": 2,
"Status": 0,
"JobType": 0,
"JobInput": "sample string 3",
"JobOutput": "sample string 4",
"AgentID": "1d05df27-30d5-48a5-8304-54f6cd7c4465",
"NotificationChannelID": 1,
"StartTime": "2024-12-28T01:32:08.8802078-07:00",
"EndTime": "2024-12-28T01:32:08.8802078-07:00",
"TotalItemCount": 1,
"CompletedItemCount": 1,
"rowver": "QEA="
}
application/xml, text/xml
Sample:
<JobInstance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ICM.ViewCenter.BusinessEntities"> <AgentID>1d05df27-30d5-48a5-8304-54f6cd7c4465</AgentID> <CompletedItemCount>1</CompletedItemCount> <EndTime>2024-12-28T01:32:08.8802078-07:00</EndTime> <JobDefinitionID>2</JobDefinitionID> <JobInput>sample string 3</JobInput> <JobInstanceID>1</JobInstanceID> <JobOutput>sample string 4</JobOutput> <JobType>NotSpecified</JobType> <NotificationChannelID>1</NotificationChannelID> <StartTime>2024-12-28T01:32:08.8802078-07:00</StartTime> <Status>Queued</Status> <TotalItemCount>1</TotalItemCount> <rowver>QEA=</rowver> </JobInstance>