Perform Check Alert Action

PUT

Applies a check alert action to the specified check alert RID.

Path parameters

checkAlertRidstringRequired

Request

This endpoint expects an object.

Close with Ignore

Close with Further Action

Reopen

Reassign

Update Notes

Link Notebook

Unlink Notebook

Response

This endpoint returns an object.

ridstring

checkRidstring

dataReviewRidstring

checkEvaluationRidstring

namestring

assigneeRidsset of strings

startobject

stateobject

priorityenum

Allowed values: P0P1P2P3P4

implementationIndexintegerOptional

autogeneratedCheckTitlestringOptional

autogeneratedCheckDescriptionstringOptional

endobjectOptional

chartobjectOptional

notesstringOptional

notebookstringOptional

PUT

1 curl -X PUT https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/checkAlertRid \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "type": "closeWithIgnore",
6   "closeWithIgnore": {
7     "comment": "comment"
8   }
9 }'

200Updated

1 {
2   "rid": "rid",
3   "checkRid": "checkRid",
4   "dataReviewRid": "dataReviewRid",
5   "checkEvaluationRid": "checkEvaluationRid",
6   "name": "name",
7   "assigneeRids": [
8     "assigneeRids"
9   ],
10   "start": {
11     "seconds": 1000000,
12     "nanos": 1000000,
13     "picos": 1
14   },
15   "state": {
16     "type": "pendingReview",
17     "pendingReview": {}
18   },
19   "priority": "P0",
20   "implementationIndex": 1,
21   "autogeneratedCheckTitle": "autogeneratedCheckTitle",
22   "autogeneratedCheckDescription": "autogeneratedCheckDescription",
23   "end": {
24     "seconds": 1000000,
25     "nanos": 1000000,
26     "picos": 1
27   },
28   "chart": {
29     "rid": "rid",
30     "version": 1
31   },
32   "notes": "notes",
33   "notebook": "notebook"
34 }

Batch Perform Check Alert Action

Up Next

Built with

1	curl -X PUT https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/checkAlertRid \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"type": "closeWithIgnore",
6	"closeWithIgnore": {
7	"comment": "comment"
8	}
9	}'

1	{
2	"rid": "rid",
3	"checkRid": "checkRid",
4	"dataReviewRid": "dataReviewRid",
5	"checkEvaluationRid": "checkEvaluationRid",
6	"name": "name",
7	"assigneeRids": [
8	"assigneeRids"
9	],
10	"start": {
11	"seconds": 1000000,
12	"nanos": 1000000,
13	"picos": 1
14	},
15	"state": {
16	"type": "pendingReview",
17	"pendingReview": {}
18	},
19	"priority": "P0",
20	"implementationIndex": 1,
21	"autogeneratedCheckTitle": "autogeneratedCheckTitle",
22	"autogeneratedCheckDescription": "autogeneratedCheckDescription",
23	"end": {
24	"seconds": 1000000,
25	"nanos": 1000000,
26	"picos": 1
27	},
28	"chart": {
29	"rid": "rid",
30	"version": 1
31	},
32	"notes": "notes",
33	"notebook": "notebook"
34	}