Retrieve an existing asset by path.

get

https://example.com/authoring/v1/assets/record

Use this endpoint to retrieve an existing asset that matches the path that has been set. A conditional request is supported.
User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

path

string

required

Provide the path of the asset that you want to retrieve.

fields

array of strings

Only the asset fields that are specified here are returned for each result. Any asset field is a valid value and these can be specified in a comma-separated list. For example, to list the asset fields name and ID, provide the value ID, and name. All asset fields are returned by default.

fields

include

array of strings

Optional: Parameters used to include additional fields inside each returned asset. Use "links" to include the links section, which contains URLs for actions that can be performed on the asset. Use "metadata" to include additional fields for each of the items referenced by the asset You can specify multiple fields as a comma-separated value. For example, "include=links,metadata".

include

Headers

If-None-Match

string

Provide the double quoted revision of the asset. If this value matches the newest version, a 304 Not Modified response will be returned.

Responses

304

The Etag provided in the If-None-Match header corresponds to the latest version.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved an existing asset that matches the path that you provided.

400The path provided was not valid.

404The asset with the provided path was not found.

412The Etag provided in the If-None-Match header does not correspond to the latest version.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

503Connection failed to data store.

defaultUnexpected error.