- URL:https://<jobs-url>/<jobID>
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.1
Description
A job represents the asynchronous execution of an operation. Progress information can be acquired by periodically querying this resource.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default response format is html. Values: html | json| pjson |
Example usage
Below is a sample request URL for an individual job resource:
https://machine.domain.com/webadaptor/admin/system/jobs/jcbdbf7aa-385e-417a-b629-29a310895b9b?f=jsonJSON Response syntax
{
"jobid": "<jobID>",
"status": "<status>",
"totalsteps": <total steps>,
"currentstep": <current step>,
"stepInfo": [ "<msg1>", "<msg2>", ...],
"operationResponse": <operation response>
}JSON Response example
{
"jobid": "jcbdbf7aa-385e-417a-b629-29a310895b9b",
"status": "COMPLETED",
"totalsteps": 3,
"currentstep": 3,
"stepInfo": [
"Stopping the service 'USA' on machine 'MACHINE.DOMAIN.COM'",
"Saving edits to the configuration store",
"Starting the service 'USA' on machine 'MACHINE.DOMAIN.COM'",
"Stopping the service 'USA' on machine 'MACHINE.DOMAIN.COM'"
],
"operationResponse": {
"status": "error","messages": [
"service failed to start"
],
"detail": {
"service": "USA.MapServer",
"state": "FAILED",
"message": "",
"machines": [
{
"machine": "MACHINE.DOMAIN.COM",
"state": "FAILED","reports": [
{
"state": "FAILED",
"message": "Cannot open file \\server\share\USA.MSD.
The system cannot find the file specified or it is inaccessible to the server."
}
]
}
]
}
}
}