Find Data Reviews

POST

Returns the data reviews under the provided search parameters.

Request

This endpoint expects an object.

runRidsset of stringsRequired

assetRidsset of stringsRequired

checklistRefsset of objectsRequired

nextPageTokenstringOptional

pageSizeintegerOptional

Defaults to 1000. Will throw if larger than 1000.

showArchivedbooleanOptionalDefaults to false

Defaults to false if not specified.

Response

This endpoint returns an object.

dataReviewslist of objects

nextPageTokenstringOptional

POST

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

200Successful

1 {
2   "dataReviews": [
3     {
4       "rid": "rid",
5       "runRid": "runRid",
6       "createdAt": "2024-01-15T09:30:00Z",
7       "createdBy": "createdBy",
8       "checklist": {
9         "checklist": {
10           "rid": "rid",
11           "commit": "commit"
12         },
13         "dataReviewRid": "dataReviewRid",
14         "checks": [
15           {
16             "type": "automaticCheck",
17             "automaticCheck": {
18               "rid": "rid",
19               "checkRid": "checkRid",
20               "dataReviewRid": "dataReviewRid",
21               "state": {
22                 "type": "pendingExecution",
23                 "pendingExecution": {
24                   "jobRid": "jobRid"
25                 }
26               },
27               "checkImplementationIndex": 1
28             }
29           }
30         ]
31       },
32       "archived": true
33     },
34     {
35       "rid": "rid",
36       "runRid": "runRid",
37       "createdAt": "2024-01-15T09:30:00Z",
38       "createdBy": "createdBy",
39       "checklist": {
40         "checklist": {
41           "rid": "rid",
42           "commit": "commit"
43         },
44         "dataReviewRid": "dataReviewRid",
45         "checks": [
46           {
47             "type": "automaticCheck",
48             "automaticCheck": {
49               "rid": "rid",
50               "checkRid": "checkRid",
51               "dataReviewRid": "dataReviewRid",
52               "state": {
53                 "type": "pendingExecution",
54                 "pendingExecution": {
55                   "jobRid": "jobRid"
56                 }
57               },
58               "checkImplementationIndex": 1
59             }
60           }
61         ]
62       },
63       "archived": true
64     }
65   ],
66   "nextPageToken": "nextPageToken"
67 }

Get

Up Next

Built with

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

1	{
2	"dataReviews": [
3	{
4	"rid": "rid",
5	"runRid": "runRid",
6	"createdAt": "2024-01-15T09:30:00Z",
7	"createdBy": "createdBy",
8	"checklist": {
9	"checklist": {
10	"rid": "rid",
11	"commit": "commit"
12	},
13	"dataReviewRid": "dataReviewRid",
14	"checks": [
15	{
16	"type": "automaticCheck",
17	"automaticCheck": {
18	"rid": "rid",
19	"checkRid": "checkRid",
20	"dataReviewRid": "dataReviewRid",
21	"state": {
22	"type": "pendingExecution",
23	"pendingExecution": {
24	"jobRid": "jobRid"
25	}
26	},
27	"checkImplementationIndex": 1
28	}
29	}
30	]
31	},
32	"archived": true
33	},
34	{
35	"rid": "rid",
36	"runRid": "runRid",
37	"createdAt": "2024-01-15T09:30:00Z",
38	"createdBy": "createdBy",
39	"checklist": {
40	"checklist": {
41	"rid": "rid",
42	"commit": "commit"
43	},
44	"dataReviewRid": "dataReviewRid",
45	"checks": [
46	{
47	"type": "automaticCheck",
48	"automaticCheck": {
49	"rid": "rid",
50	"checkRid": "checkRid",
51	"dataReviewRid": "dataReviewRid",
52	"state": {
53	"type": "pendingExecution",
54	"pendingExecution": {
55	"jobRid": "jobRid"
56	}
57	},
58	"checkImplementationIndex": 1
59	}
60	}
61	]
62	},
63	"archived": true
64	}
65	],
66	"nextPageToken": "nextPageToken"
67	}