- URL:https://<jobs-url>/job/
- Version Introduced:10.9
Description
Licencia:
The use of this resource requires an ArcGIS GIS Server Advanced license and a Production Mapping or Defense Mapping server extension 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
| Parameter | Details |
|---|---|
| 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:
Nota: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": <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
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=jsonJSON Response example
The following is an example of a response:
{
"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
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-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"
]
}
}