Get a running job by ID

get/jobs/{jobId}

Returns a running job given the job's unique identifier. Associated tasks can be filtered out.

Request Samples

1

Response Samples

1{
2 "archived": false,
3 "engineProgress": {
4 "cancelled": 0,
5 "complete": 0,
6 "failed": 0,
7 "pending": 1,
8 "total": 1
9 },
10 "failedTasks": [],
11 "id": "088e6ef9-5a1f-4af0-b065-50de6033b558",
12 "jobTemplate": {
13 "description": "Load and start the project \"simple\" on the ESP server",
14 "jobTemplateId": "283d8aed-ffc2-4f1f-81fc-64d6b168fc1b",
15 "lastModifiedDt": {
16 "date": "1970-01-01",
17 "time": "00:00",
18 "timestamp": 0
19 },
20 "lastModifiedTime": 0,
21 "name": "Load and start the project \"simple\" on the ESP server",
22 "production": false,
23 "tags": [
24 "system",
25 "xml"
26 ],
27 "uploadDt": {
28 "date": "2023-01-31",
29 "time": "14:39",
30 "timestamp": 1675175942184
31 },
32 "uploadTime": 1675175942184,
33 "uploadedBy": "user1",
34 "version": 1,
35 "versionNotes": "Initial upload"
36 },
37 "parameters": [],
38 "progress": {
39 "cancelled": 0,
40 "complete": 0,
41 "failed": 0,
42 "pending": 2,
43 "total": 2
44 },
45 "startDt": {
46 "date": "2023-01-31",
47 "time": "14:39",
48 "timestamp": 1675175942516
49 },
50 "startTime": 1675175942516,
51 "startedBy": "user1",
52 "status": "STARTED",
53 "statusMessage": "Running",
54 "tasks": [
55 {
56 "duration": 58,
57 "endTime": 0,
58 "id": "load-project",
59 "name": "Loaf the project \"simple\" on the ESP server",
60 "startTime": 0,
61 "status": "PENDING",
62 "statusMessage": "Scheduled",
63 "taskProgress": {
64 "cancelled": 0,
65 "complete": 0,
66 "failed": 0,
67 "pending": 2,
68 "total": 2
69 }
70 },
71 {
72 "duration": 60,
73 "endTime": 0,
74 "id": "start-project",
75 "name": "Start the loaded project \"simple\" on the ESP server",
76 "startTime": 0,
77 "status": "PENDING",
78 "statusMessage": "Scheduled",
79 "taskProgress": {
80 "cancelled": 0,
81 "complete": 0,
82 "failed": 0,
83 "pending": 2,
84 "total": 2
85 }
86 }
87 ]
88}

Path Parameters

NameTypeRequiredDescription
jobId
string
true

The unique identifier of the job.

Query Parameters

NameTypeRequiredDescription
cancelled
boolean
false

If set to false, then these tasks are not included.

Default:
true
completed
boolean
false

If set to false, then these tasks are not included.

Default:
true
completedWithFailures
boolean
false

If set to false, then these tasks will are not included.

Default:
true
notStarted
boolean
false

If set to false, then these tasks are not included.

Default:
true
running
boolean
false

If set to false, then these tasks are not included.

Default:
true

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema