Get a job by jobId
Get the details of a job by jobId.
If the job contains active versions, they are returned in an active array with the following information:
- name: The name of the version.
- url: The feature service URL.
- layerItemId: The organization item ID of the source feature layer.
- versionID: The GUID for the version in version management server.
If the job contains extended properties and ext is set to true, they are returned in an extended array with the following information:
- tableName: The name of the extended property table.
- featureServiceProperties: Available when a job contains feature service extended properties.
- properties: The array of the properties in the extended property table, includes
propertyandName value.
If the job contains feature service extended properties and ext is set to true, they are returned within extended as a feature object with the following information:
- itemId: ItemId for the feature service in Portal or AGOL.
- layerid: LayerId for the layer in the Feature service.
- portalType: Specifies where the feature service is located.
Currentfor feature services available on the same portal as Workflow Manager,ArcGISfor feature services available on AGOL andOnline Otherfor public feature services available on a different portal. - featureServiceUniqueId: The field from the feature service as linked field stored in the extended property table.
- portalUrl: Portal url for the feature service. This field is specified only for portalType.
- secure: Specifies whether the feature service is secure or not.
If the job contains a hold or dependency, it is returned in the corresponding current step in the current array with the following information:
- manualHold: If the step is on hold with a manual or scheduled hold
- dependencies: If the step has dependencies on another job
- holdScheduledRelease: Date and time stamp the scheduled hold is released
Jobs that have a current or past hold will return the following information in the holds array if holds is set to true:
- jobId: JobId for the job containing a hold
- stepId: StepId for the step on hold
- holdId: HoldId for the hold
- setBy: Username for the user who added the hold
- setDate: Date and time stamp for when the hold was added
- scheduledRelease: If the step has a current hold, date and time stamp for when the hold is scheduled to be released
- releasedBy: If the step has a past hold, the username for the user who released the hold
- releasedDate: If the step has a past hold, date and time stamp for when the hold was released
Jobs that contain a dependency will return the following infrormation in the holds array if holds is set to true:
- dependentJobId: JobId for the job dependent on the current or past hold
- dependentStepId: StepId for the step dependent on the current or past hold
If the job is a parent job, a unique ID for the job is returned:
- parentJobRefId: Unique ID for the parent job
Query parameters
| Name | Type | Required |
|---|---|---|
| | |
| | |
| |
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| | |
| |
Examples
Request
# You can also use wget
curl -X GET /{orgId}/{itemId}/jobs/{jobId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'Response
200 Response
{
"jobId": "string",
"jobName": "string",
"ownedBy": "string",
"createdBy": "string",
"notes": "string",
"description": "string",
"createdDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"startedDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"parentJob": "string",
"percentComplete": 0,
"priority": "string",
"diagramId": "string",
"diagramVersion": 0,
"diagramName": "string",
"currentSteps": [
{
"stepId": "string",
"assignedTo": "string",
"assignedType": "Unassigned",
"stepName": "string",
"canSkip": true,
"manualHold": true,
"holdScheduledRelease": "2019-08-24T14:15:22Z",
"dependencies": true
}
],
"jobStatus": "string",
"jobTemplateId": "string",
"jobTemplateName": "string",
"extendedProperties": [
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
],
"relatedProperties": [
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"entries": [
{
"id": "string",
"createdDate": "2019-08-24T14:15:22Z",
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
]
}
],
"holds": [
{
"jobId": "string",
"stepId": "string",
"holdId": "string",
"setBy": "string",
"setDate": "2019-08-24T14:15:22Z",
"scheduledRelease": "2019-08-24T14:15:22Z",
"releasedBy": "string",
"releasedDate": "2019-08-24T14:15:22Z",
"dependentJobId": "string",
"dependentStepId": "string"
}
],
"activeVersions": [
{
"name": "string",
"url": "string",
"privateUrl": "string",
"layerItemId": "string",
"versionId": "string",
"replicaName": "string",
"replicaId": "string",
"replicaLocation": "string",
"proReplicaLocation": "string"
}
],
"hasLocation": 0,
"parentJobRefId": "string",
"closed": true,
"archived": true
}| Status | Meaning | Description | Schema |
|---|---|---|---|
| success | ||
| error |