Text item history endpoint

The Text item history 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:

/n/v1/textitemhistory/

textitemhistory was introduced in API version V1

Text item history has not been marked for deprecation

See Text Item History for representation details.

Description

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 example

Text Item History
Representation of the history of a text item including all of the revisions stored which may be paged if they exceed the maximum per response.

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.