Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring layouts

Retrieve all layouts in the database ordered by last modified date.

Use the /layouts/views/by-modified endpoint to retrieve all layouts from the database and list them in the order of their last modified date.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/layouts/views/by-modified

Query parameters

startstring date-time

Provide the date and time of when the last modifications were made to the layouts that you want returned. When the order is ascending (default), the layouts that are modified on or after this date and time are returned. When the order is descending, the layouts that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

endstring date-time

Provide the date and time of when the last modifications were made to the layouts that you want returned. When the order is ascending (default), the layouts that are modified on or before this date and time are returned. When the order is descending, the layouts that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

startIdstring

If start does not uniquely identify the result to start from, you can specify the UUID of the result as startId.

endIdstring

If end does not uniquely identify the result to end at, you can specify the UUID of the result as endId.

offsetnumber

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

limitnumber

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

format'feed' | 'array' | 'sequence'

Specify the result format.

  • feed - (default) returns a wrapper with links
  • array - returns just the array of results
  • sequence - each result is a separate JSON document on a new line
pageMode'offset' | 'deep'

Specify the next and previous page link mode.

  • offset - (default) allows paging forward or backwards, but only a small number of times
  • deep - uses index keys to efficiently page through a large result set, but only in one direction
order'ascending' | 'descending'

Specify whether you want the layout documents to be returned in ascending/oldest-first (default) or descending/newest-first order.

fieldsstring

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.

Response

Success.

offsetinteger

number of results to skip.

limitinteger

number of results to return.

hrefstring

the url of the current query.

nextstring

the url for the next page of results. Only present if there are more results.

previousstring

the url for the previous page of results. Not present when on the first page.

Example response

{
  "items": [
    {
      "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"
    }
  ]
}