Sign in
Class Definition

Create a new object brick definition

Changed on

Create a new object brick definition with the provided <strong>{key}</strong>. <br> The <strong>{key}</strong> must be unique and not already exist.

post/pimcore-studio/api/class/object-brick

Request

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

Request body

keystring required

Key of the object brick

Example request

{
  "key": "MyObjectBrick"
}

Response

Created object brick definition detail

additionalAttributesobject

AdditionalAttributes

keystring required

Key

titlestring nullable required

Title

groupstring nullable required

Group

parentClassstring nullable required

Namespace of parent class

implementsInterfacesstring nullable required

Interface implementations

blockedVarsForExportstring[] required

Blocked variables for export

isWriteableboolean required

Whether the object brick definition can be written to

Example response

{
  "key": "MyObjectBrick",
  "title": "My Object Brick",
  "group": "system",
  "parentClass": "App\\Model\\DataObject\\ObjectBrick",
  "implementsInterfaces": "App\\Model\\DataObject\\Interface",
  "blockedVarsForExport": [],
  "isWriteable": true,
  "classDefinitions": [
    {
      "classname": "fieldTest",
      "fieldname": "myBrickField"
    }
  ]
}

Changes