- URL:
- https://<root>/services/<folderName>/<ServiceName>.<ServiceType>/jobs/query
- Methods:
GET- Required Capability:
- Access allowed with either the "Feature layer" or "Geoprocessing" privileges, or the Publisher role
- Version Introduced:
- 10.9.1
Description
The query operation allows you to query jobs pertaining to a geoprocessing service, using a combination of the following parameters:
Request parameters
| Parameter | Details |
|---|---|
(Optional) | The earliest time to query. Time is specified in milliseconds from epoch. Example |
(Optional) | The most recent time to query. If unspecified, the current time will be used. If you specify a value for this parameter, you must also specify a Example |
(Required) | The current status of a job. The value set with this parameter will be used to filter the jobs by that set job status. Values: |
(Optional) | The name of the user who submitted the job. Example |
(Optional) | The number of jobs to display in the response. The default value is 10. Example |
| The response format. The default format is Values: |
Response properties
| Property | Details |
|---|---|
| The total number of jobs found by the query. |
| The parameter specified by your query, including the |
| The number of jobs returned on each result page. |
| The order number of the job with which the response begins. |
| The order number of the job that will be the first response on the next results page if the query returns more responses than the value specified for the number parameter. This property is intended to be used as the |
| The jobs found by the query matching your specifications. This returns the |
Example usage
The following is a sample request URL for the query operation:
https://organization.domain.com/context/admin/services/System/PublishingTools.GPServer/jobs/query?startTime=&endTime=&jobStatus=esriJobSucceeded&userName=&number=10&f=pjsonJSON Response example
{
"total": 41,
"query": {
"serviceName": "PublishingTools",
"userName": "",
"status": ["esriJobSucceeded"]
},
"num": 10,
"start": 1,
"nextStart": 11,
"results": {
"j0550714f334d4114af9f7a5d05cb145e": "Succeeded",
"j6123787782ba45f7a65d215630fe931b": "Succeeded",
"j9bbbb5e272e946fdaf844e86cc6d513a": "Succeeded",
"j4f0095e5b9a145aeb3783050d2b04fe0": "Succeeded",
"j73318a2d534c4241b53559068ababdba": "Succeeded",
"j52db3d9281f84038aafed219ef8a94ca": "Succeeded",
"j42e60c06389b4b7295ea21490e92bc74": "Succeeded",
"j8c18f527a1d34b40b0e8fa7cb271e176": "Succeeded",
"j8420a05a6faf4bce971b6f621f69881c": "Succeeded",
"j5c501b3c20fb49f585dfe1b3a29ce641": "Succeeded"
}
}