Add document review decision

POST 
/documents/:documentId/reviews/:reviewId/decisions

Add a decision to a document review. When approvalGroups is set on the review, the caller must belong to at least one of those groups, in addition to satisfying the existing authorization requirements, before the decision is added. Decisions submitted to a review that is already COMPLETED return 409 Conflict without creating a decision, follow-up review, notification, or activity record.

Request

Path Parameters

documentId stringrequired

Document Identifier

reviewId stringrequired

Review Identifier

Query Parameters

siteId string

Site Identifier

artifactId string

Artifact Document Identifier

application/json

Body

required

decision

object

required

type ReviewDecisionType (string)required

Possible values: [APPROVAL, RECOMMENDATION, ACKNOWLEDGMENT, COMMENT]

decision string

Review decision

comment string

Review decision comment

review

object

reviewCategory stringrequired

Review category

reviewStatus DocumentReviewStatus (string)

Status of Document Review:

• PENDING: Review has been created and is waiting for one or more decisions.
• IN_PROGRESS: Review has been claimed or at least one decision has been submitted, but completion requirements are not yet satisfied.
• COMPLETED: Completion requirements are satisfied.
• CANCELLED: Review was cancelled before completion.
• SUPERSEDED: Review was replaced by another review, usually because the artifact/document changed.

Possible values: [PENDING, IN_PROGRESS, COMPLETED, CANCELLED, SUPERSEDED]

approvalGroups string[]

Optional approval groups used for additional credential verification when submitting a decision to POST /documents/{documentId}/reviews/{reviewId}/decisions. The caller must belong to at least one of the listed groups, in addition to satisfying the existing authorization requirements.

requiredDecisions int64required

Number of decisions required to complete the review

Possible values: >= 1

notifications

object[]

Optional notifications to queue for delivery when the review is created. An empty list sends no notifications.

Array [

notificationType DocumentNotificationType (string)required

Type of document notification

Possible values: [EMAIL, IN_APP]

cc email[]

CC recipient email addresses

Possible values: >= 1

bcc email[]

BCC recipient email addresses

Possible values: >= 1

subject stringrequired

Notification subject

Possible values: non-empty

body stringrequired

Notification body

Possible values: non-empty

]

comments string

Review comments

Responses

201

201 CREATED

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

decisionId stringrequired

Decision Identifier

Example (from schema)

{
  "decisionId": "string"
}

409

The review is already complete. No decision was created.

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Review is already complete"
}

Loading...