Retrieve an existing review.get https://example.com/authoring/v1/review/{id}Use the /review/{id} endpoint to retrieve an existing review that matches the ID that is specified from the database. This endpoint returns the API representation of the requested review. User roles: admin, manager, editor, viewerLog in to see full request historyURL ExpiredThe URL for this request expired after 30 days.Path ParamsidstringrequiredProvide the ID of the review that you want to retrieve.Responses 200Successfully retrieved the API representation for the existing review that matches the ID that you provided.Response bodyobjectidstringrequiredThe ID of the review.revstringrequiredThe current revision of the review.classificationstringThe review's classification.namestringrequiredThe name of the review.targetDatedate-timeOptional. Set a target date for when the review is due and must end.statusstringThe status of a review. The initial status of a review is active, changed to complete when it is ended. active completeapprovalStatusstringThe approval status of a review. The initial status of a review is not-approved, changed to approved when all items has been approved. approved not-approvedcompleteddate-timeThe completed date of this review in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.approversarray of objectsApprovers' user ID for the review.approversobjectidstringapprovalsarray of objectsApprovals for a review.approvalsobjectuserobjectA user object with user ID.User objectdatedate-timeThe approved date in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.itemsarray of objectsThe ID of the items that been approved in a approval.itemsobjectidstringclassificationThe classification of the item.rejectionsarray of objectsRejections for a review.rejectionsobjectuserobjectA user object with user ID.User objectdatedate-timeThe approved date in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.itemsarray of objectsThe ID of the items that been rejected in a rejection.itemsobjectidstringclassificationThe classification of the item.itemsarray of objectsProvide the ID of the items that you want to submit for review. The unique ID (uid) is the items classification and the ID combined to create an ID that is unique across all content hub items.Unique ID listobjectidstringclassificationThe classification of the item.lastModifieddate-timeThe last modified date of this review in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.lastModifierIdstringThe ID of the user that last modified the review.createddate-timeThe created date of this review in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.creatorIdstringThe ID of the creator of the review. 404The review with ID {id} was not found.Response bodyobjectrequestIdstringrequiredThe current request IDservicestringrequiredThe name of the service that produced the errorrequestMethodstringrequiredThe HTTP method type of the current requestrequestUristringrequiredThe request URIerrorsarray of objectsrequirederrors*objectcodeintegerrequiredThe message codekeystringrequiredThe message keymessagestringrequiredThe error messagedescriptionstringrequiredOptional detailed error messagemore_infostringrequiredOptional additional information for the messagecategorystringrequiredThe message category whereby only user messages are designed to be shown to an end user API USERlevelstringrequiredIndicates the message level INFO WARNING ERRORparametersobjectrequiredThe message parameters of this message.Has additional fieldsfieldstringrequiredOnly present on field validation errors, indicates the field in error.localestringrequiredThe current locale used to produce the error message. 429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.Response bodyobjecterrorsarray of objectsrequirederrors*objectcodeintegerrequiredAn error codemessagestringrequiredA message describing what went wrong.descriptionstringFurther explanation of the error condition and potential next steps to resolve the problem.more_infostringA URL pointing to a web site that provides more information on the given error condition.levelstringThe severity level of the message. Default is error. ERROR WARNINGparametersobjectAdditional properties reflecting the dynamic parts of the error condition.Has additional fieldscauseobjectThis property can be used to transport causing error message records produced by a down stream service calls.Has additional fieldslocalestringThis property represents the locale of the text contained in properties 'message', and 'description'. This property is mandatory if message and description contain translated text.requestIdstringrequiredThe ID of the failing request.servicestringThe name of the service serving the error message. 503Unable to retrieve the review from the database as the service is unavailable. Try again later.Response bodyobjectrequestIdstringrequiredThe current request IDservicestringrequiredThe name of the service that produced the errorrequestMethodstringrequiredThe HTTP method type of the current requestrequestUristringrequiredThe request URIerrorsarray of objectsrequirederrors*objectcodeintegerrequiredThe message codekeystringrequiredThe message keymessagestringrequiredThe error messagedescriptionstringrequiredOptional detailed error messagemore_infostringrequiredOptional additional information for the messagecategorystringrequiredThe message category whereby only user messages are designed to be shown to an end user API USERlevelstringrequiredIndicates the message level INFO WARNING ERRORparametersobjectrequiredThe message parameters of this message.Has additional fieldsfieldstringrequiredOnly present on field validation errors, indicates the field in error.localestringrequiredThe current locale used to produce the error message. defaultUnexpected error.Response bodyobjectrequestIdstringrequiredThe current request IDservicestringrequiredThe name of the service that produced the errorrequestMethodstringrequiredThe HTTP method type of the current requestrequestUristringrequiredThe request URIerrorsarray of objectsrequirederrors*objectcodeintegerrequiredThe message codekeystringrequiredThe message keymessagestringrequiredThe error messagedescriptionstringrequiredOptional detailed error messagemore_infostringrequiredOptional additional information for the messagecategorystringrequiredThe message category whereby only user messages are designed to be shown to an end user API USERlevelstringrequiredIndicates the message level INFO WARNING ERRORparametersobjectrequiredThe message parameters of this message.Has additional fieldsfieldstringrequiredOnly present on field validation errors, indicates the field in error.localestringrequiredThe current locale used to produce the error message.Updated almost 4 years ago Start a review.Update an existing review.Did this page help you?YesNo
