Sign in
Data Objects

Get layout of a data object by ID

Changed on

Retrieves the layout of a specific data object based on the given <strong>{id}</strong>. <br> The <strong>{id}</strong> must be an ID of existing data object.

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

Successfully retrieved data object layout data as JSON

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,
  "previewConfig": [
    {
      "name": "locale",
      "label": "Locale",
      "values": [
        {
          "key": "English (en)",
          "value": "en"
        }
      ],
      "defaultValue": "en"
    }
  ]
}

Changes

  • 81b097a1505fRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • 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