Retrieves the layouts associated with the specified content.

get

https://example.com/authoring/v1/layouts/by-content/{content-id}

Use the /layouts/by-content/{contentId} endpoint to retrieve the layouts associated with the specified content. When the 'filter' query string parameter is set to 'selected', only the selected layout (which could be a content override) is returned.
User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

content-id

string

required

The ID of the content whose associated layouts should be returned.

Query Params

projectId

string

Optionally specifies the context for draft overlay. Contains the project id, or special values:
draft for standalone draft overlays none for no project overlay.

When both the 'projectId' query-string parameter AND the 'x-ibm-dx-project-id' header are specified, the 'projectId' query-string parameter will override the 'x-ibm-dx-project-id' header.

filter

string

An optional filter to control the returned results.
Valid options are:
* selected: Indicates that only the selected layout should be returned.

offset

number

Defaults to 0

Use the offset parameter to specify the number of layouts to skip and return the rest.

limit

number

Defaults to 50

Set the limit for the number of layouts that are returned.

fields

string

Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list.

Headers

x-ibm-dx-project-id

string

Optionally specifies the context for draft overlay. Contains the project id, or special values:
draft for standalone draft overlays none for no project overlay.

When both the 'projectId' query-string parameter AND the 'x-ibm-dx-project-id' header are specified, the 'projectId' query-string parameter will override the 'x-ibm-dx-project-id' header.

Responses

200Success.

400Invalid ID OR Invalid input.

404The content with ID {contentId} was not found OR Current tenant's database is not provisioned.

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