Job

URL:
https://<jobs-url>/<job_id>
Methods:
GET
Version Introduced:
10.8.1

Description

A job represents the asynchronous execution of an operation. Progress information can be acquired by periodically querying this resource. Each message in messages has an associated

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Below is a sample request URL for the job resource:

Use dark colors for code blocksCopy
1

JSON Response syntax

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
{
    "jobId": "<job_id>",
    "messages": [
        "<messages>",
        ...
    ],
    "startTime": <epoch_start_time>,
    "endTime": <epoch_stop_time>,
    "type": "<operation>",
    "status": "COMPLETED",
    "username": "<username>",
    "customAttributes": {
        "stepsCompleted": <no_steps>,
        "isCancelled": <boolean>,
        "missionId": "<mission_id>",
        "messageCodes": [
            <message_code>,
            ...
        ],
        "totalSteps": <steps>
    }
}

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
35
36
37
38
39
40
{
    "jobId": "j522676d9-983a-48e2-a51c-5066966160f0",
    "messages": [
        "Started mission creation.",
        "Creating tracks layers for location awareness.",
        "Creating communications layers for collaboration.",
        "Creating events layers for mission logs.",
        "Created tracks layers for location awareness.",
        "Created communications layers for collaboration.",
        "Created events layers for mission logs.",
        "Creating map for visualization.",
        "Created map for visualization.",
        "Finishing mission creation.",
        "Finished creating mission d942d2bdb70c4104bcd1a76d4cf8a6b7."
    ],
    "startTime": 1590523221196,
    "endTime": 1590523287507,
    "type": "addMission",
    "status": "COMPLETED",
    "username": "admin",
    "customAttributes": {
        "stepsCompleted": 5,
        "isCancelled": false,
        "missionId": "d942d2bdb70c4104bcd1a76d4cf8a6b7",
        "messageCodes": [
            1500,
            1501,
            1503,
            1505,
            1502,
            1504,
            1506,
            1507,
            1508,
            1509,
            1510
        ],
        "totalSteps": 5
    }
}

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