Sign in
Data Objects

data_object_get_layout_by_id_summary

data_object_get_layout_by_id_description

get/pimcore-studio/api/data-objects/{id}/layout

Request

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

Path parameters

idinteger required
Example:83

Id of the data-object

Query parameters

layoutIdstring
Example:Todo

ID to get specific layout

Response

data_object_get_layout_by_id_success_response

additionalAttributesobject

AdditionalAttributes

namestring required

Name

dataTypestring required

Data Type

fieldTypestring required

Field Type

typestring nullable required

Type

layoutstring nullable required

Layout

regionstring nullable required

Region

titlestring nullable required

Title

widthinteger required

Width

heightinteger required

Height

collapsibleboolean required

Collapsible

collapsedboolean required

Collapsed

bodyStylestring nullable required

Body Style

lockedboolean required

Locked

childrenobject[] required

Children

labelAlignstring required

Label Align

labelWidthinteger required

Label Width

borderboolean required

Border

Example response

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

No recorded changes to this operation across all 2 revisions of this API.