Job

Description

A job represents the asynchronous execution of an operation. You can acquire progress information by periodically querying the job.

Request Parameters

Parameter

Details

f

Description: The response format. The default response format is html.

Values: html | json

Response Format

{
  "jobid": "<jobID>",
  "status": "<status>",
  "totalsteps": <total steps>,
  "currentstep": <current step>,
  "stepInfo": [ "<msg1>", "<msg2>", ...],
  "operationResponse": <operation response>
}

Example Usage

{
	"jobid": "jcbdbf7aa-385e-417a-b629-29a310895b9b",
	"status": "COMPLETED",
	"totalsteps": 3,
	"currentstep": 3,
	"stepInfo": [
		"Stopping the service 'USA' on  machine 'SERVER.DOMAIN.COM'",
		"Saving edits to the configuration store",
		"Starting the service 'USA' on machine 'SERVER.DOMAIN.COM'",
		"Stopping the service 'USA' on machine 'SERVER.DOMAIN.COM'"    
	],
	"operationResponse": {
		"status": "error",
		"messages": [ "service failed to start" ],
		"detail": {
			"service": "USA.MapServer",
			"state": "FAILED",
			"message": "",
			"machines": [
				{
					"machine": "SERVER.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."
						}
					]
				}
			]
		}
	}
}

10/6/2017