v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring layouts

Retrieve all layout mappings in the database ordered by last modified date.

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

get/authoring/v1/layout-mappings/views/by-modified

Query parameters

startstring date-time

Provide the date and time of when the last modifications were made to the layout mappings 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 layout mappings 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 layout mappings to skip and return the rest.

limitnumber

Set the limit for the number of layout mappings 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 mapping documents to be returned in ascending/oldest-first (default) or descending/newest-first order.

fieldsstring

Only the layout mapping fields that are specified here are returned for each result. Any layout mapping 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": "e0192c4c-9633-4853-856a-ce04e37ec40c",
      "rev": "1d5fc65f4cd277eb5340355db7ecdfde75",
      "name": "Sample layout mapping",
      "creatorId": "8c622bbb-5f5b-45d4-89e1-fce1c054138f",
      "creator": "Thomas Watson",
      "created": "2016-11-02T06:28:47Z",
      "lastModifierId": "8c622bbb-5f5b-45d4-89e1-fce1c054138f",
      "lastModifier": "Thomas Watson",
      "lastModified": "2016-11-02T06:28:47Z",
      "path": "/myLayoutMappings/SampleMapping.json",
      "tags": [
        "news",
        "sample"
      ],
      "type": {
        "id": "092c46f6-09c0-4ffe-9f21-52d041b4a73c",
        "name": "Sample Type"
      },
      "mappings": [
        {
          "defaultLayout": {
            "id": "f26044ca-d92d-49e8-acd9-00563c1e0db9",
            "name": "Sample Layout"
          },
          "layouts": [
            {
              "id": "f26044ca-d92d-49e8-acd9-00563c1e0db9",
              "name": "Sample Layout"
            }
          ]
        }
      ]
    }
  ]
}