Job

URL:
https://<root>/<serviceName>/TopographicProductionServer/jobs/job/<request parameters>
Methods:
GET
Required Capability:
Requires an ArcGIS GIS Server Advanced license and a Production Mapping or Defense Mapping server extension license
Version Introduced:
10.9

Description

The job operation tracks the status of a job executed by the generateProduct REST operation and can return 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 .

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
 "status": <untranslated string representing general status of the job>,
 "statusCode": <code representing specific status of the job>,
 "submissionTime": <time and date of the job submission in UTC and ISO 8601 format YYYY-MM-DDThh:mm:ssZ>,
 "lastUpdatedTime": <time and date of the last job update in UTC and ISO 8601 format YYYY-MM-DDThh:mm:ssZ>,
 "percentComplete": <percent of the job completed>,
 "aoiLayer": <URL of AOI layer>,
 "aoiFeatureId": <AOI feature ID>,
 "outputUrl": <URL of output>,
 "user": <username>,
 "jobId": <job identifier>,
 "productName": <name of the product>,
 "productVersion": <version of the product>,
 "outputType": <type/format of the output>,
 "messages": {
  <informative | error | warning>
 }
}

Example usage

Use the job's ID with the job REST operation to track its status.

Request URL and parameters:

Use dark colors for code blocksCopy
1
https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/jobs/job/D7F25D87-DE3C-4DD5-808B-3A168C32E403
Use dark colors for code blocksCopy
1
f=json

JSON Response example

The following is an example of a response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
 "status": "InProgress",
 "statusCode": 3,
 "submissionTime": "2020-08-12T18:45:09Z",
 "lastUpdatedTime": "2020-08-12T18:45:28Z",
 "percentComplete": 0.052631578947368418,
 "aoiLayer": "https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/jobs/job/5",
 "aoiFeatureId": 120733
 "outputUrl":
 "user": "user1",
 "jobId": "22AEBB64-5554-4567-85A4-FE83B6DE8063",
 "productName": "MTM50",
 "productVersion": "Test",
 "outputType": "PDF",
 "messages": {

 }
}

Example usage

Review the informative messages associated with a specific job using the job REST operation.

Request URL and parameters:

Use dark colors for code blocksCopy
1
https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/jobs/job/D7F25D87-DE3C-4DD5-808B-3A168C32E403
Use dark colors for code blocksCopy
1
2
f=json
msgLevel=info

JSON Response example

The following is an example of a response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
 "status": "InProgress",
 "statusCode": 3,
 "submissionTime": "2020-08-12T18:45:09Z",
 "lastUpdatedTime": "2020-08-12T18:45:28Z",
 "percentComplete": 0.052631578947368418,
 "aoiLayer": "https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/jobs/job/5",
 "aoiFeatureId": 120733
 "outputUrl":
 "user": "user1",
 "jobId": "22AEBB64-5554-4567-85A4-FE83B6DE8063",
 "productName": "MTM50",
 "productVersion": "Test",
 "outputType": "PDF",
 "messages": {
  "informative": [
   "Submitted.",
   "Executing...",
   "Start Time: Wednesday, August 12, 2020 06:45:28 PM",
   "Starting to generate product MTM50.",
   "Start Time: Wednesday, August 12, 2020 06:45:28 PM",
   "Executing Import Template and Extract Features",
   "Start Time: Wednesday, August 12, 2020 06:45:28 PM"
  ]
 }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.