Job

URL:
https://<root>/system/jobs/<jobID>
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

An individual job resource returns the current progress for a current or previously run job. A job represents the asynchronous execution of an operation. Progress information can be acquired by periodically querying this resource.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access an individual job resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/admin/system/jobs/jcbdbf7aa-385e-417a-b629-29a310895b9b?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "jobid": "<jobID>",
  "status": "<status>",
  "totalsteps": <total steps>,
  "currentstep": <current step>,
  "stepInfo": [ "<msg1>", "<msg2>", ...],
  "operationResponse": <operation response>
}

JSON Response example

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
27
28
29
30
31
32
33
34
{
  "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."
            }
          ]
        }
      ]
    }
  }
}

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