Batch Get Checks

POST

https://api.gov.nominal.io/api/scout/v1/checklists/check/batch-get

POST

/api/scout/v1/checklists/check/batch-get

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/checklists/check/batch-get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   "string"
6 ]'

Try it

200Successful

1 [
2   {
3     "rid": "rid",
4     "checkLineageRid": "checkLineageRid",
5     "title": "title",
6     "description": "description",
7     "priority": "P0",
8     "autoGeneratedTitle": "autoGeneratedTitle",
9     "autoGeneratedDescription": "autoGeneratedDescription",
10     "chart": {
11       "rid": "rid",
12       "version": 1
13     },
14     "condition": {
15       "type": "numRanges",
16       "numRanges": {
17         "ranges": {
18           "type": "function",
19           "function": {
20             "functionReference": "functionReference",
21             "functionIdentifier": {
22               "type": "variable",
23               "variable": "functionIdentifier"
24             }
25           }
26         },
27         "functionSpec": {
28           "key": "value"
29         },
30         "threshold": 1,
31         "operator": "GREATER_THAN",
32         "variables": {
33           "variables": {
34             "dataSourceRef": "dataSourceRef",
35             "channel": "channel",
36             "tags": {
37               "tags": "tags"
38             }
39           }
40         }
41       }
42     }
43   }
44 ]

Returns the checks with the given rids.

Request

This endpoint expects a set of strings.

Response

This endpoint returns a set of objects.

ridstring

checkLineageRidstring

titlestring

descriptionstring

priorityenum

Allowed values:

autoGeneratedTitlestringOptional

autoGeneratedDescriptionstringOptional

chartobjectOptional

conditionobjectOptional

If omitted, this check represents a manual check.

Headers

Request

Response