Create review

POST

/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{projectPolicyControlId}/reviews

curl --request POST \
  --url https://localhost:10001/api/v1/projects/1/policies/1/controls/1/reviews \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "attachmentCid": [ "example" ], "cid": "example", "commentType": "GENERAL", "createdAt": "example", "extra": { "additionalProperty": "example" }, "fileAttachments": [ { "contentType": "example", "declarationId": 1, "description": "example", "fileName": "example", "id": 1, "isPublic": true, "retentionExpires": "example", "reviewId": 1, "sizeBytes": 1, "storagePath": "example", "uploadedAt": "example", "uploadedBy": "example" } ], "id": 1, "outcome": "NON_COMPLIANT", "projectPolicyControlId": 1, "statement": "example", "subjectLine": "example", "submittedAt": "example", "submittedBy": "example", "updatedAt": "example" }'

Submit a review for a specific control and return the persisted record

Authorizations

• BearerAuth

Parameters

Path Parameters

projectId

required

integer

Project ID

projectPolicyId

required

integer

Project Policy ID

projectPolicyControlId

required

integer

Project Policy Control ID

Request Body

Review data

Media type application/json

object

attachmentCid

Array<string>

cid

string

commentType

string

Allowed values: GENERAL ACCEPTED QUESTIONED

createdAt

string

extra

object

key

additional properties

string

fileAttachments

Array<object>

object

contentType

string

declarationId

integer

description

string

fileName

string

id

integer

isPublic

boolean

retentionExpires

string

reviewId

integer

sizeBytes

integer

storagePath

string

uploadedAt

string

uploadedBy

string

id

integer

outcome

string

Allowed values: NON_COMPLIANT NOT_APPLICABLE COMPLIANT COMMENT

projectPolicyControlId

integer

statement

string

subjectLine

string

submittedAt

string

submittedBy

string

updatedAt

string

Responses

201

Created review

Media type application/json

object

attachmentCid

Array<string>

cid

string

commentType

string

Allowed values: GENERAL ACCEPTED QUESTIONED

createdAt

string

extra

object

key

additional properties

string

fileAttachments

Array<object>

object

contentType

string

declarationId

integer

description

string

fileName

string

id

integer

isPublic

boolean

retentionExpires

string

reviewId

integer

sizeBytes

integer

storagePath

string

uploadedAt

string

uploadedBy

string

id

integer

outcome

string

Allowed values: NON_COMPLIANT NOT_APPLICABLE COMPLIANT COMMENT

projectPolicyControlId

integer

statement

string

subjectLine

string

submittedAt

string

submittedBy

string

updatedAt

string

Example

{
  "commentType": "GENERAL",
  "outcome": "NON_COMPLIANT"
}

400

Bad request - Invalid IDs or request body

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

401

Unauthorized - Authentication required

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

403

Forbidden - Insufficient permissions for this review outcome

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

404

No matching control found in project policy

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

500

Internal server error

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}