v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring review

Retrieve an existing review.

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. <br />User roles: admin, manager, editor, viewer

get/authoring/v1/review/{id}

Path parameters

idstring required

Provide the ID of the review that you want to retrieve.

Response

Successfully retrieved the API representation for the existing review that matches the ID that you provided.

idstring required

The ID of the review.

revstring required

The current revision of the review.

classificationstring

The review's classification.

namestring required

The name of the review.

targetDatestring date-time

Optional. Set a target date for when the review is due and must end.

status'active' | 'complete'

The status of a review. The initial status of a review is active, changed to complete when it is ended.

approvalStatus'approved' | 'not-approved'

The approval status of a review. The initial status of a review is not-approved, changed to approved when all items has been approved.

completedstring date-time

The completed date of this review in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

lastModifiedstring date-time

The last modified date of this review in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

lastModifierIdstring

The ID of the user that last modified the review.

createdstring date-time

The created date of this review in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ.

creatorIdstring

The ID of the creator of the review.

Example response

{
  "id": "0d36aaf9-ddb3-4f3c-8582-5a0cea2c48b4",
  "rev": "1-b79b6fe8de3e2b63c45895f733482774",
  "classification": "review",
  "name": "Sample Review",
  "targetDate": "2018-01-22T03:00:20.945Z",
  "completed": "2018-01-22T03:00:20.945Z",
  "approvers": [
    {
      "id": "45341daf-6b42-40c9-8aea-e9e24bf83b0a"
    }
  ],
  "approvals": [
    {
      "user": {
        "id": "45341daf-6b42-40c9-8aea-e9e24bf83b0a"
      },
      "date": "2018-01-22T03:00:20.945Z",
      "items": [
        {
          "id": "a9e1e857-4eb3-4994-9214-3ed739a9987b",
          "classification": "content"
        }
      ]
    }
  ],
  "rejections": [
    {
      "user": {
        "id": "45341daf-6b42-40c9-8aea-e9e24bf83b0a"
      },
      "date": "2018-01-22T03:00:20.945Z",
      "items": [
        {
          "id": "a9e1e857-4eb3-4994-9214-3ed739a9987b",
          "classification": "content"
        }
      ]
    }
  ],
  "items": [
    {
      "id": "a9e1e857-4eb3-4994-9214-3ed739a9987b",
      "classification": "content"
    }
  ],
  "lastModified": "2018-01-22T03:00:20.945Z",
  "lastModifierId": "63b800fa-51a7-4602-8cbe-ab3b9cee28b9",
  "created": "2018-01-22T03:00:20.945Z",
  "creatorId": "8c622bbb-5f5b-45d4-89e1-fce1c054138f"
}