Search Check Alerts

POST

Returns the check alerts under the provided search parameters.

Request

This endpoint expects an object.

runRidsset of stringsRequired

assetRidsset of stringsRequired

nextPageTokenstringOptional

pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1_000.

sortByobjectOptional

If not present, will sort by start time in descending order.

searchTextstringOptional

Matches on check name

afterobjectOptional

Filters to start times after this time, inclusive.

beforeobjectOptional

Filters to start times before this time, exclusive.

statusset of enumsOptional

Allowed values: PENDING_REVIEWCLOSED_IGNOREDCLOSED_REQUIRES_FURTHER_ACTION

checkRidsset of stringsOptional

dataReviewRidsset of stringsOptional

assigneeRidsset of stringsOptional

prioritiesset of enumsOptional

Allowed values: P0P1P2P3P4

pinnedChecklistRefsset of objectsOptional

chartRidsset of objectsOptional

notebookRidsset of stringsOptional

showArchivedbooleanOptionalDefaults to false

If not present, will not show archived data reviews in search results

Response

This endpoint returns an object.

checkAlertslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "runRids": [
6     "runRids"
7   ],
8   "assetRids": [
9     "assetRids"
10   ]
11 }'

200Successful

1 {
2   "checkAlerts": [
3     {
4       "rid": "rid",
5       "checkRid": "checkRid",
6       "dataReviewRid": "dataReviewRid",
7       "checkEvaluationRid": "checkEvaluationRid",
8       "name": "name",
9       "assigneeRids": [
10         "assigneeRids"
11       ],
12       "start": {
13         "seconds": 1000000,
14         "nanos": 1000000,
15         "picos": 1
16       },
17       "state": {
18         "type": "pendingReview",
19         "pendingReview": {}
20       },
21       "priority": "P0",
22       "implementationIndex": 1,
23       "autogeneratedCheckTitle": "autogeneratedCheckTitle",
24       "autogeneratedCheckDescription": "autogeneratedCheckDescription",
25       "end": {
26         "seconds": 1000000,
27         "nanos": 1000000,
28         "picos": 1
29       },
30       "chart": {
31         "rid": "rid",
32         "version": 1
33       },
34       "notes": "notes",
35       "notebook": "notebook"
36     },
37     {
38       "rid": "rid",
39       "checkRid": "checkRid",
40       "dataReviewRid": "dataReviewRid",
41       "checkEvaluationRid": "checkEvaluationRid",
42       "name": "name",
43       "assigneeRids": [
44         "assigneeRids"
45       ],
46       "start": {
47         "seconds": 1000000,
48         "nanos": 1000000,
49         "picos": 1
50       },
51       "state": {
52         "type": "pendingReview",
53         "pendingReview": {}
54       },
55       "priority": "P0",
56       "implementationIndex": 1,
57       "autogeneratedCheckTitle": "autogeneratedCheckTitle",
58       "autogeneratedCheckDescription": "autogeneratedCheckDescription",
59       "end": {
60         "seconds": 1000000,
61         "nanos": 1000000,
62         "picos": 1
63       },
64       "chart": {
65         "rid": "rid",
66         "version": 1
67       },
68       "notes": "notes",
69       "notebook": "notebook"
70     }
71   ],
72   "nextPageToken": "nextPageToken"
73 }

Get Check Alert Action Log

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"runRids": [
6	"runRids"
7	],
8	"assetRids": [
9	"assetRids"
10	]
11	}'

1	{
2	"checkAlerts": [
3	{
4	"rid": "rid",
5	"checkRid": "checkRid",
6	"dataReviewRid": "dataReviewRid",
7	"checkEvaluationRid": "checkEvaluationRid",
8	"name": "name",
9	"assigneeRids": [
10	"assigneeRids"
11	],
12	"start": {
13	"seconds": 1000000,
14	"nanos": 1000000,
15	"picos": 1
16	},
17	"state": {
18	"type": "pendingReview",
19	"pendingReview": {}
20	},
21	"priority": "P0",
22	"implementationIndex": 1,
23	"autogeneratedCheckTitle": "autogeneratedCheckTitle",
24	"autogeneratedCheckDescription": "autogeneratedCheckDescription",
25	"end": {
26	"seconds": 1000000,
27	"nanos": 1000000,
28	"picos": 1
29	},
30	"chart": {
31	"rid": "rid",
32	"version": 1
33	},
34	"notes": "notes",
35	"notebook": "notebook"
36	},
37	{
38	"rid": "rid",
39	"checkRid": "checkRid",
40	"dataReviewRid": "dataReviewRid",
41	"checkEvaluationRid": "checkEvaluationRid",
42	"name": "name",
43	"assigneeRids": [
44	"assigneeRids"
45	],
46	"start": {
47	"seconds": 1000000,
48	"nanos": 1000000,
49	"picos": 1
50	},
51	"state": {
52	"type": "pendingReview",
53	"pendingReview": {}
54	},
55	"priority": "P0",
56	"implementationIndex": 1,
57	"autogeneratedCheckTitle": "autogeneratedCheckTitle",
58	"autogeneratedCheckDescription": "autogeneratedCheckDescription",
59	"end": {
60	"seconds": 1000000,
61	"nanos": 1000000,
62	"picos": 1
63	},
64	"chart": {
65	"rid": "rid",
66	"version": 1
67	},
68	"notes": "notes",
69	"notebook": "notebook"
70	}
71	],
72	"nextPageToken": "nextPageToken"
73	}