Skip To Content
ArcGIS Developers
Dashboard

Job

  • URL:https://<jobs-url>/job/
  • Version Introduced:10.9

Description

License:

The use of this resource requires an ArcGIS GIS Server Advanced license and a Production Mapping Server or Defense Mapping Server license.

The job operation tracks the status of a job executed by the generateProduct REST operation and returns the status, start date, last modified date, and messages of the job.

Request parameters

ParameterDetails
jobId

(Required)

The unique job identifier to add to the query URL, for example, ...jobs/job/<jobID>.

msgLevel

(Optional)

The message level associated with the job. The values are the following:

  • info
  • warn
  • error
When constructing a query URL, the msgLevel value is added to the end of the URL, for example, ...jobs/job/<jobID>?msgLevel=info.
Note:

Regardless of the msgLevel value, any errors that a job contains are included in the messages array of the response by default.

JSON Response syntax

The following is the syntax of a response:

{
 "status": <status of the job>,
 "statusCode": <status code>,
 "submissionTime": <time and date of the job submission>,
 "lastUpdatedTime": <time and date of the last job update>,
 "percentComplete": <percent of the job completed>,
 "messages": {
  <informative | error | warning>
 }
 "user": <user>,
 "jobId": <job identifier>
}

Example usage

The following URL queries for a job by jobID:

https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/jobs/job/D7F25D87-DE3C-4DD5-808B-3A168C32E403?f=json

JSON Response example

The following is an example of a response:

{
 "status": "InProgress",
 "statusCode": 3,
 "submissionTime": "2020/08/12 18:45:09",
 "lastUpdatedTime": "2020/08/12 18:45:28",
 "percentComplete": 0.052631578947368418,
 "messages": {
  
 }
 "user": "user1",
 "jobId: "22AEBB64-5554-4567-85A4-FE83B6DE8063"
}

Example usage

The following URL queries for a job by jobId and msgLevel:

https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/jobs/job/D7F25D87-DE3C-4DD5-808B-3A168C32E403?f=json&msgLevel=info

JSON Response example

The following is an example of a response:

{
 "status": "InProgress",
 "statusCode": 3,
 "submissionTime": "2020/08/12 18:45:09",
 "lastUpdatedTime": "2020/08/12 18:45:28",
 "percentComplete": 0.052631578947368418,
 "messages": {
  "informative": [
   "Submitted.",
   "Executing...",
   "Start Time: Wednesday, August 12, 2020 11:45:14 AM",
   "Starting to generate product MTM50.",
   "Start Time: Wednesday, August 12, 2020 11:45:28 AM",
   "Executing Import Template and Extract Features",
   "Start Time: Wednesday, August 12, 2020 11:45:28 AM"
  ]
 }
 "user": "user1",
 "jobId": "22AEBB64-5554-4567-85A4-FE83B6DE8063"
}