Entity View endpoint

The Entity View endpoint and fields are described below including details of the supported RESTful CRUD verbs. For details of the conventions of the API see the general conventions.

Endpoint path prefix:

/v/v1/entityview/

entityview was introduced in API version V1

Entity View has not been marked for deprecation

Description

Endpoint used for viewing rendered content entities with content items transformed. This endpoint is intended to be used by content clients and supports access via roles. See the PermissionRole endpoint for details of creating a role with read access to the entity. Multiple clients can then be assigned the role which mustuse the READ permission label. This allows client access from installed apps using a restricted API Client as company level access tokens have admin permissions.

The entity view endpoint is read only.
Only content entities can be read via this endpoint.

Verbs / methods

This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.

READ HTTP GET

Response codes / scenarios

  • NOT_FOUND

    API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.

  • READ_SUCCESS

    API code READ_SUCCESS HTTP status code 200 : On read when the request is successful. The returned representation is given with the relevant 2XX HTTP code without further detail.