1. REST API for Sites Management
  2. Tasks
  3. Requests
  4. Reviews

Get a Review

get

/sites/management/api/v1/requests/{id}/reviews/{reviewId}

SINGULAR

Get the details of the review, such as the review decision and comment. The reviewer details can be included in the response using expansion.

Authorization

Site administrators can read all reviews. If a user created the request they can read the reviews.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK - Find Out Who Created the Review

Read the review details and expand the reviewedBy relationship. Links are not returned in the response.

Request

GET https://api.example.com/sites/management/api/v1/requests/{id}/reviews/{reviewId}?expand=reviewedBy&links=none

Response Body

{
  "id": 0,
  "decision": "rejected",
  "comment": "I do not like the name",
  "createdAt": "2019-06-06T11:46:38.651Z",
  "reviewedBy": {
    "type": "user",
    "id": "1234",
    "userName": "jsmith",
    "displayName": "John Smith",
    "email": "jsmith@example.com"
  }
}

Client Error Response Examples

This operation responds with following client error (4xx) responses with exception details in the response body. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

404Not Found - Review Not Found

The review does not exist or has been deleted, or the authenticated user or client application does not have access to the request review.

Error Code

OCE-SITEMGMT-009007

Resolution - Check Identifier

Check that the review identifier is valid.

Resolution - Check Authorization

Check that the authenticated user is allowed to review the request or that the authenticated user is the user that created the request.

Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
reviewReview that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the ReviewNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Review Not Found",
  "status": "404",
  "detail": "Review does not exist or has been deleted, or the authenticated user or client application does not have access to the review.",
  "o:errorCode": "OCE-SITEMGMT-009007",
  "review": {
    "id": 0
  }
}

Request

Path Parameters

  • Globally unique immutable identifier for a request.

  • Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.

Query Parameters

  • Comma-delimited string of field names that should not be included in the response.

  • Comma-separated list of link relation names to exclude from the response.

  • Comma-delimited string of field names that you want to expand. Use the value all to expand all relationships.

    The following field names can be specified in the expand query parameter:

    Field NameDescription
    reviewedByGet the details of the user or client application that created the review.

  • Specify how errors in expansion are handled. If not specified, then the default is to include error details in the relationship field.

    Valid values are:

    • ignore - Ignore the error and do not expand the relationship. Relationship links are not included in the response
    • include - Include the error details instead of the expanded relationship. Relationship links are returned
    • fail - Fail the request with an expansion failure error response

  • Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

  • Comma-separated list of link relation names to include in the response. By default, all links are returned.

    The following links are provided by this resource:

    Link RelationshipDescription
    parentDescribes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
    selfDescribes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
    canonicalDescribes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
    describedByDescribes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.

  • Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

    The following representations are supported with the return query parameter:

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Header Parameters

  • The if match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that one of those entity tag values is current. If the requested resource does not match any of the provided entity tag values a precondition failed response will be returned without any body.

  • The if none match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that none of those entity tag values is current.

Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Match All
Show Source
  • Review

    A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

Nested Schema : Review

A review is the human initiated review of a request, with the aim to approve or reject the request. A review either approves or rejects the request, with an an optional comment which can be used by the request initiator to understand why the request was approved or rejected by the user. Depending on the type of approval associated with a request, zero or more reviews may be required. For example, auto approved requests do not need a review. An administrator approval requires one administrator to review the request.

Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Review-allOf[1]
Nested Schema : SingularResource
Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source
  • links
Nested Schema : Review-allOf[1]
Type: object
Show Source
  • Maximum Length: 1000

    A comment associated with the review can be used to describe why the request was approved or rejected. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

  • Date and time that the review was created. Date and time values are in ISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format using a UTC timezone.

  • Outcome of this review, either approve or reject the request.

    Valid values are:

    • approved - Associated request is approved
    • rejected - Associated request is rejected

  • Request scoped identifier for the review. Reviews identifiers are generated by the system when the review is created and cannot be changed. The identifier is only unique within the scope of the parent request. Newest reviews have the smaller identifier value.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  • reviewedBy

    Get the details of the user or client application that created the review.

Nested Schema : reviewedBy

Get the details of the user or client application that created the review.

Match All
Show Source
  • Identity
    Discriminator: type

    Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

    Introduced in release 20.3.1.
Nested Schema : Identity
Discriminator: type

Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

Introduced in release 20.3.1.
Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Identity-allOf[1]
Nested Schema : Identity-allOf[1]
Type: object
Show Source

  • Human-readable display name.

    Introduced in release 20.3.1.

  • An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 20.3.1.

  • Unique name, such as the user name or client application name.

    Introduced in release 20.3.1.
  • roles

    Roles.

    Valid values are:

    • CECServiceAdministrator - Service Administrator
    • Assign user enumerates
    • Change user passwords and challenge questions
    • Configure, monitor, and manage service instances
    • CECSitesAdministrator - Sites Administrator
    • Create sites, templates, themes or components
    • CECRepositoryAdministrator - Repository Administrator
    • CECDeveloperUser - Developer User
    • CECContentAdministrator - Content Administrator
    • Create new content types and publish items
    • CECStandardUser - Standard User
    • Manage content (view, upload, and edit documents)
    • Share content and sites with others
    • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
    • Follow people
    • Create, edit, and publish sites
    • Manage and publish site themes
    • Create, register, export, and import custom site components
    • Create, edit, export, and import site templates
    • View and interact with content items in sites
    • Manage and view custom properties and edit values
    • CECEnterpriseUser - Enterprise User
    • Manage content (view, upload, and edit documents)
    • Share content and sites with others
    • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
    • Follow people
    • Digital Assets
    • Content Items (editorial content management)
    • Create, manage, view, and interact with content items
    • Collections
    • Create, edit, and publish sites
    • Manage and publish site themes
    • Create, register, export, and import custom site components
    • Create, edit, export, and import site templates
    • Manage and view custom properties and edit values
    • CECExternalUser - External User
    Reserved for future use.
    • CECIntegrationUser - Integration User
    Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
    • CECSitesVisitor - Sites Visitor
    Access sites restricted to visitors.

    Introduced in release 21.10.2.

  • Type of Identity. Valid values are: user, service, application, unknown.

    Introduced in release 20.3.1.
Nested Schema : roles
Type: array

Roles.

Valid values are:

  • CECServiceAdministrator - Service Administrator
  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator
  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator
  • Create new content types and publish items
  • CECStandardUser - Standard User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User
Reserved for future use.
  • CECIntegrationUser - Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
  • CECSitesVisitor - Sites Visitor
Access sites restricted to visitors.

Introduced in release 21.10.2.
Show Source
Example Response (Find Out Who Created the Review)
{
    "id":0,
    "decision":"rejected",
    "comment":"I do not like the name",
    "createdAt":"2019-06-06T11:46:38.651Z",
    "reviewedBy":{
        "type":"user",
        "id":"1234",
        "userName":"jsmith",
        "displayName":"John Smith",
        "email":"jsmith@example.com"
    }
}

304 Response

Not Modified

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : ReviewNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : ReviewNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Review Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Review Not Found",
    "status":"404",
    "detail":"Review does not exist or has been deleted, or the authenticated user or client application does not have access to the review.",
    "o:errorCode":"OCE-SITEMGMT-009007",
    "review":{
        "id":0
    }
}

406 Response

Not Acceptable

412 Response

Precondition Failed

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top