Assessments

Request changes on or reject an assessment

POST
/organizations/{organizationId}/forms/submissions/{submissionId}/decide-review

Approval is a separate endpoint, since only approval mints a record and starts the clocks.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

organizationId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
submissionId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms/submissions/497f6eca-6276-4993-bfeb-53cbbbba6f08/decide-review" \  -H "Content-Type: application/json" \  -d '{    "decision": "requestChanges"  }'
{  "id": "string",  "organizationId": "string",  "templateId": "string",  "templateSource": "global",  "templateKind": "policy",  "templateVersion": -9007199254740991,  "name": "string",  "status": "draft",  "approvalState": "draft",  "primaryRecordType": "dataSystem",  "primaryRecordId": "string",  "relatedRecords": [    {      "type": "dataSystem",      "id": "string"    }  ],  "assigneeId": "string",  "reviewerIds": [    "string"  ],  "assignments": [    {      "id": "string",      "targetType": "section",      "targetId": "string",      "assigneeId": "string",      "dueAt": null    }  ],  "dueAt": null,  "approvedBy": "string",  "approvedAt": null,  "approvedReleaseId": "string",  "nextReviewDueAt": null,  "reviewCadenceMonths": -9007199254740991,  "materialChangeReopenedAt": null,  "retainUntil": null,  "riskFindings": [    {      "id": "string",      "description": "string",      "likelihood": 1,      "severity": 1,      "mitigation": "string",      "residualLikelihood": 1,      "residualSeverity": 1,      "ownerId": "string",      "riskId": "string",      "ruleId": "string",      "riskTemplateId": "string",      "affectedRecords": [        {          "type": "dataSystem",          "id": "string"        }      ],      "contributedByShareId": "string"    }  ],  "satisfiedObligations": [    "string"  ],  "answerMeta": {    "property1": {      "origin": "user",      "sourceRef": "string"    },    "property2": {      "origin": "user",      "sourceRef": "string"    }  },  "answers": {    "property1": null,    "property2": null  },  "projectId": null,  "generatedDocumentId": "string",  "reviewComments": [    {      "comment": "string",      "decision": "requestChanges",      "decidedBy": "string",      "decidedAt": null    }  ],  "submittedBy": "string",  "dateCreated": null,  "dateUpdated": null}