Retrieve an existing layout mapping via its associated content-type.

get

https://example.com/authoring/v1/layout-mappings/by-type/{type-id}

Use the /layout-mappings/by-type/{type-id} end-point to retrieve an existing layout mapping from the database.
User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type-id

string

required

The ID of the content-type whose layout mapping should be retrieved.

Query Params

fields

string

A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping field is a valid value.

include

string

A comma separated list of additional fields (which are normally hidden) to add to the response.
Valid options are:
metadata: Adds additional details such as creator, last modifier and the names of mapped layouts to the response. all: Adds all current and future additional fields to the response.
When used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.

Headers

If-None-Match

string

Provide an Etag value from a previous request to check whether the layout mapping retrieved is the most recent version. If the layout mapping is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout mapping back.

Responses

304

Not modified is returned when using If-None-Match header and the value matches the latest version of the item.

200Success.

400Invalid ID OR Invalid input.

404There is no layout-mapping associated with the specified content-type OR Current tenant's database is not provisioned OR the operation is not available based on the current tenant's tier.

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