Batch Perform Check Alert Action

POST

Applies a check alert action to the specified check alert RIDs. If any of the check actions fail, then none of the check actions will be applied.

Request

This endpoint expects an object.

checkAlertActionobjectRequired

checkAlertRidsset of stringsRequired

Response

This endpoint returns an object.

checkAlertsset of objects

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/batch-perform-action \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "checkAlertAction": {
6     "type": "closeWithIgnore",
7     "closeWithIgnore": {
8       "comment": "comment"
9     }
10   },
11   "checkAlertRids": [
12     "checkAlertRids"
13   ]
14 }'

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 }

Batch Perform Automatic Check Evaluation Review Action

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/batch-perform-action \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"checkAlertAction": {
6	"type": "closeWithIgnore",
7	"closeWithIgnore": {
8	"comment": "comment"
9	}
10	},
11	"checkAlertRids": [
12	"checkAlertRids"
13	]
14	}'

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	}