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       "assetRid": "assetRid"
9     },
10     {
11       "checklistRid": "checklistRid",
12       "assetRid": "assetRid"
13     }
14   ]
15 }'

Try it

200Successful

1 {
2   "checklistLiveStatusResponses": [
3     {
4       "checklistRid": "checklistRid",
5       "assetRid": "assetRid",
6       "status": {
7         "type": "running",
8         "running": {
9           "commitId": "commitId",
10           "checkResults": [
11             {
12               "status": {
13                 "type": "pass",
14                 "pass": {}
15               },
16               "checkRid": "checkRid",
17               "checkParameterIndex": 1
18             }
19           ]
20         }
21       }
22     },
23     {
24       "checklistRid": "checklistRid",
25       "assetRid": "assetRid",
26       "status": {
27         "type": "running",
28         "running": {
29           "commitId": "commitId",
30           "checkResults": [
31             {
32               "status": {
33                 "type": "pass",
34                 "pass": {}
35               },
36               "checkRid": "checkRid",
37               "checkParameterIndex": 1
38             }
39           ]
40         }
41       }
42     }
43   ]
44 }

For each request, get the latest status for each check in a streaming checklist against the given asset.

Request

This endpoint expects an object.

requestslist of objectsRequired

Response

This endpoint returns an object.

checklistLiveStatusResponseslist of objects

Headers

Request

Response