- URL:
- https://<catalog-url>/<serviceName>/GPServer/<taskname>/jobs/<job-id>
- Methods:
GET
- Version Introduced:
- 10.9.1
Description
The GP job
resource represents a job submitted using the submit
operation. It provides basic information about the job such as the job ID, status, and messages. Additionally, if the job has successfully completed, it provides information about the result parameters as well as the input parameters.
- Job ID, as
job
, is a system assigned ID for each job. Each job has a unique ID.Id - Status, as
job
, is the current status of the job. It can be any one of the following values:Status esri
,Job Cancelled esri
,Job Cancelling esri
,Job Executing esri
,Job Failed esri
,Job New esri
,Job Succeeded esri
,Job Timed Out esri
,Job Submitted esri
, orJob Waiting expected
.Failure - Progress, as
progress
, see the messages bullet. - Messages, as
messages
, allow you to specify whether the messages will be returned to you usingreturn
. To configure the message level, see Show Messages.Messages - Output, as
results
, if any. All result values can be accessed using the GPresults
resource. The JSON response specifies a relative URL to the result resource with aparam
field.Url - Input, as
inputs
, if any. All input parameter values are accessed using the GPinputs
resource. The JSON response specifies a relative URL to the input resource with aparam
field.Url
The job
resource supports a cancel
job operation. This operation can be used to cancel a job before it's completed. If your geoprocessing service is Python code with no ArcPy functions, the cancellation request will not be fulfilled.
Request parameters
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
JSON Response syntax
{
"jobId": "<jobId>",
"jobStatus": "<jobStatus>",
"results": {
"<param1>": {
"paramUrl": "<relativeUrlToParam1>"
},
"<param2>": {
"paramUrl": "<relativeUrlToParam2>"
}
},
"inputs": {
"<param1>": {
"paramUrl": "<relativeUrlToParam1>"
},
"<param2>": {
"paramUrl": "<relativeUrlToParam2>"
}
},
"messages": [
{
"type": "<type1>",
"description": "<description1>"
},
{
"type": "<type2>",
"description": "<description2>"
}
]
}
JSON Response example
{
"jobId": "j8f8783b5-1b5a-4faf-859c-851c9a837232",
"jobStatus": "esriJobSucceeded",
"inputs": {
"input_feature_layer": {
"paramUrl": "inputs/input_feature_layer"
}
},
"messages": [
{
"description": "Input Notebook Path: C:\\arcgis\\home\\.tasks\\j8f8783b5-1b5a-4faf-859c-851c9a837232\\5061085ca6b44ab69aa3358a987b0513.ipynb\r",
"type": "esriJobMessageTypeInformative"
},
{
"description": "Output Notebook Path: C:\\arcgis\\home\\.tasks\\j8f8783b5-1b5a-4faf-859c-851c9a837232\\output.ipynb\r",
"type": "esriJobMessageTypeInformative"
},
{
"description": "Start processing time: 2023-02-22 13:37:37.977559\r",
"type": "esriJobMessageTypeInformative"
},
{
"description": "Finish processing time: 2023-02-22 13:37:57.945772\r",
"type": "esriJobMessageTypeInformative"
},
{
"description": "Successfully completed.",
"type": "esriJobMessageTypeInformative"
}
],
"startTime": 1677101838182,
"endTime": 1677101885841,
"type": "executeNotebookAsWebTool",
"results": {
"output_feature_layer": {
"paramUrl": "results/output_feature_layer"
}
},
"status": "COMPLETED",
"username": "user@DOMAIN",
"customAttributes": {
"isCancelled": false,
"webToolParameters": "[{\"parameterType\":\"esriGPParameterTypeRequired\",\"displayName\":\"Input Feature\",\"defaultValue\":{\"url\":\"https://sampleserver6.arcgisonline.com/arcgis/rest/services/Hurricanes/MapServer/0\"},\"dataType\":\"GPFeatureRecordSetLayer\",\"name\":\"input_feature_layer\",\"description\":\"Test input feature layer\",\"category\":\"\",\"direction\":\"esriGPParameterDirectionInput\"},{\"parameterType\":\"esriGPParameterTypeRequired\",\"displayName\":\"Output Feature\",\"defaultValue\":{\"url\":\"https://dev0015021.esri.com/server/rest/services/Hosted/ALS_Clinics_CA/FeatureServer/0\"},\"dataType\":\"GPFeatureRecordSetLayer\",\"name\":\"output_feature_layer\",\"description\":\"Output feature layer\",\"category\":\"\",\"direction\":\"esriGPParameterDirectionOutput\"}]"
}
}