Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring layouts

Retrieve an existing layout.

Use the /layouts/{id} end-point to retrieve an existing layout from the database.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/layouts/{id}

Path parameters

idstring required

The ID of the layout to retrieve.

Query parameters

fieldsstring

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

includestring

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 and last modifier 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-Matchstring

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

Response

Success.

idstring

The ID of the layout.

revstring required

The current revision of the layout.

namestring required

The name of the layout.

descriptionstring

The description of the layout.

classification'layout'

Indicates the type of this document.

creatorIdstring

The ID of the user that created the layout.

creatorstring

The display name of the user that created the layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

createdstring date-time

The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

lastModifierIdstring

The ID of the user that last modified the layout.

lastModifierstring

The display name of the last user that modified the layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.

lastModifiedstring date-time

The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

pathstring

Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].

prerenderboolean

Indicates if the layout should be prerendered.

tagsstring[]
templatestring required
templateType'handlebars' | 'angular'

Specifies the type of template associated with this layout. This field is required when prerender field is set to true.

urlTemplatestring

Specifies the pattern for url generation.

isSystemboolean

Indicates whether this item is a 'system item' or not.

Example response

{
  "id": "f26044ca-d92d-49e8-acd9-00563c1e0db9",
  "rev": "139c63397272172e73f52d22f22f606f6c",
  "name": "Sample layout",
  "description": "An example description of the sample layout",
  "creatorId": "8c622bbb-5f5b-45d4-89e1-fce1c054138f",
  "creator": "Thomas Watson",
  "lastModifierId": "8c622bbb-5f5b-45d4-89e1-fce1c054138f",
  "lastModifier": "Thomas Watson",
  "path": "/myLayouts/SampleLayout.json",
  "tags": [
    "news",
    "sample"
  ],
  "thumbnail": {
    "id": "6c622bbb-5f5b-45d4-89e1-fce1c054138f",
    "path": "/sales/images/hub.png",
    "url": "/authoring/v1/resources/d45c83a8-2738-48a2-89e1-35256ee16283.jpg"
  },
  "template": "/mytemplates/template.hbs",
  "templateType": "handlebars"
}