Class Definition

Get custom layout by given id

Changed on

Get custom layout by given id

get/pimcore-studio/api/class/custom-layout/{customLayoutId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/class/custom-layout/{customLayoutId}
  • Auth: none declared

Path parameters

customLayoutIdstring required
Example:CarTodo

Id of custom layout

Response

Custom layout data

additionalAttributesobject

AdditionalAttributes

idstring required

Id of custom layout

namestring required

Name

descriptionstring required

Description

creationDateinteger required

Creation date timestamp

modificationDateinteger required

Modification date timestamp

userOwnerinteger nullable required

User id of owner

classIdstring required

Class id

defaultboolean required

Whether it is the default layout

Example response

{
  "id": "custom_layout_1",
  "name": "Custom Layout 1",
  "description": "This is a custom layout",
  "creationDate": 1633036800,
  "modificationDate": 1633036800,
  "userOwner": 1,
  "classId": "Product",
  "layoutDefinition": {
    "name": "pimcore_root",
    "datatype": "layout",
    "fieldtype": "panel",
    "region": "center",
    "title": "MyLayout",
    "bodyStyle": "(float: left;)",
    "icon": {
      "type": "path",
      "value": "/path/to/icon"
    },
    "labelAlign": "left",
    "labelWidth": 100,
    "previewConfig": [
      {
        "name": "locale",
        "label": "Locale",
        "values": [
          {
            "key": "English (en)",
            "value": "en"
          }
        ],
        "defaultValue": "en"
      }
    ]
  }
}

Changes

  • 81b097a1505fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      api operation id pimcore_studio_api_class_custom_layout_get removed and replaced with class_custom_layout_get

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status