v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring layouts

Update an existing layout.

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

put/authoring/v1/layouts/{id}

Path parameters

idstring required

The ID of the layout document to update.

Query parameters

forceOverrideboolean

Specifies whether revision checking should be disabled.

Request body

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 request

{
  "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"
}

Response

Success.