v1

latestOpenAPI 3.0.02026-07-2417611.8 MB

Authoring layouts

Update an existing layout mapping.

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

put/authoring/v1/layout-mappings/{id}

Path parameters

idstring required

The ID of the layout mapping document to update.

Query parameters

forceOverrideboolean

Specifies whether revision checking should be disabled.

Request body

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 request

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

Response

Success.