Sign in
Class Definition

class_custom_layout_create_summary

Changed on

class_custom_layout_create_description

post/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

class_custom_layout_create_layout_id

Request body

namestring required

Name

classIdinteger required

Data object class id

Example request

{
  "name": "My Custom Layout"
}

Response

class_custom_layout_create_success_response

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 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
  }
}

Changes