Compliance Review Request Object


A compliance review request represents a single CMS publishing or unpublishing action a user submitted for review.

It isn't stored and can't be queried. A submission returns it and carries it in the ReviewRequested event, or, for a batch, in the BulkReviewRequested event alongside the rest of the batch. Approving or rejecting it takes the same object back and carries it in the BulkReviewApproved or BulkReviewRejected event.

Properties
actionstring

Publishing or unpublishing action the user requested for the data item.


currentDataItemDataItemRead-only

Published (live) version of the data item. Returned for every action except PUBLISH_DRAFT.


idstringRead-onlyformat GUID

Compliance review request ID. Matches the _id of the submitted data item.


proposedDataItemDataItemRead-only

Version of the data item proposed by the request. For PUBLISH_PUBLISHED, this is the same published item as current_data_item. Absent only for UNPUBLISH_PUBLISHED.


submittedAtstringRead-onlyformat date-time

Date and time the action was submitted.


submittedByAccountIdstringRead-onlyformat GUID

ID of the account the action was submitted under.


submittedByUserIdstringRead-onlyformat GUID

ID of the user who submitted the action.


versionOnUnpublishstringRead-only

Version to preserve as a draft after a changed item is unpublished. Returned only for UNPUBLISH_CHANGED when the caller provides a meaningful value.

Did this help?