Checklist Live Status

POST

https://api.gov.nominal.io/api/scout/v2/checklist-execution/checklist-live-status

POST

/api/scout/v2/checklist-execution/checklist-live-status

1 curl -X POST https://api.gov.nominal.io/api/scout/v2/checklist-execution/checklist-live-status \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "requests": [
6     {
7       "checklistRid": "checklistRid"
8     },
9     {
10       "checklistRid": "checklistRid"
11     }
12   ]
13 }'

Try it

200Successful

1 {
2   "computationRange": {
3     "start": {
4       "seconds": 1000000,
5       "nanos": 1000000,
6       "picos": 1
7     },
8     "end": {
9       "seconds": 1000000,
10       "nanos": 1000000,
11       "picos": 1
12     }
13   },
14   "checklistResults": [
15     {
16       "checklistRid": "checklistRid",
17       "checkResults": [
18         {
19           "result": {
20             "type": "computed",
21             "computed": {
22               "status": {
23                 "type": "pass",
24                 "pass": {}
25               },
26               "lastFailure": {
27                 "type": "notComputed",
28                 "notComputed": {}
29               }
30             }
31           },
32           "checkRid": "checkRid",
33           "checkImplementationIndex": 1
34         },
35         {
36           "result": {
37             "type": "computed",
38             "computed": {
39               "status": {
40                 "type": "pass",
41                 "pass": {}
42               },
43               "lastFailure": {
44                 "type": "notComputed",
45                 "notComputed": {}
46               }
47             }
48           },
49           "checkRid": "checkRid",
50           "checkImplementationIndex": 1
51         }
52       ]
53     },
54     {
55       "checklistRid": "checklistRid",
56       "checkResults": [
57         {
58           "result": {
59             "type": "computed",
60             "computed": {
61               "status": {
62                 "type": "pass",
63                 "pass": {}
64               },
65               "lastFailure": {
66                 "type": "notComputed",
67                 "notComputed": {}
68               }
69             }
70           },
71           "checkRid": "checkRid",
72           "checkImplementationIndex": 1
73         },
74         {
75           "result": {
76             "type": "computed",
77             "computed": {
78               "status": {
79                 "type": "pass",
80                 "pass": {}
81               },
82               "lastFailure": {
83                 "type": "notComputed",
84                 "notComputed": {}
85               }
86             }
87           },
88           "checkRid": "checkRid",
89           "checkImplementationIndex": 1
90         }
91       ]
92     }
93   ]
94 }

For each request, get the current status and last failing time (if possible) for every automatic check against the given run.

Request

This endpoint expects an object.

requestslist of objectsRequired

computationRangeobjectOptional

The time range over which status and last failure were calculated. Failures outside of this time range will not be included in the results. If not specified, defaults to evaluating from now minus sixty minutes to now.

Response

This endpoint returns an object.

computationRangeobject

The time range over which status and last failure were calculated. Failures outside of this time range will not be included in the results.

checklistResultslist of objects

Headers

Request

Response