Get Check

GET

Returns the check with the given rid.

Path parameters

ridstringRequired

Response

This endpoint returns an object.

ridstring

checkLineageRidstring

titlestring

descriptionstring

priorityenum

Allowed values: P0P1P2P3P4

autoGeneratedTitlestringOptional

autoGeneratedDescriptionstringOptional

chartobjectOptional

conditionobjectOptional

If omitted, this check represents a manual check.

GET

1 curl https://api.gov.nominal.io/api/scout/v1/checklists/check/rid \
2      -H "Authorization: Bearer <token>"

200Retrieved

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

Batch Get Checks

Up Next

Built with

1	curl https://api.gov.nominal.io/api/scout/v1/checklists/check/rid \
2	-H "Authorization: Bearer <token>"

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