Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring layouts

Retrieve an existing layout mapping via its associated content-type.

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

get/authoring/v1/layout-mappings/by-type/{type-id}

Path parameters

type-idstring required

The ID of the content-type whose layout mapping should be retrieved.

Query parameters

fieldsstring

A comma separated list that when specified, limits the fields returned to just those specified. Any layout mapping 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, last modifier and the names of mapped layouts 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 mapping retrieved is the most recent version. If the layout mapping is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout mapping back.

Response

Success.

idstring

The ID of the layout mapping.

revstring required

The current revision of the layout mapping.

namestring required

The name of the layout mapping.

classification'layout-mapping'

Indicates the type of this document.

creatorIdstring

The ID of the user that created the layout mapping.

creatorstring

The display name of the user that created the layout mapping. 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 mapping 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 mapping.

lastModifierstring

The display name of the last user that modified the layout mapping. 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 mapping 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 mapping. Must be unique. Will default to filesystem friendly version of /[NAME].

tagsstring[]
isSystemboolean

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

Example response

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