Class Definition

Create a new field collection definition

Changed on

Create a new empty field collection definition with the given <strong>{key}</strong>. <br> The <strong>{key}</strong> must be unique and not already exist (case-insensitive). <br>

post/pimcore-studio/api/class/field-collection

Request

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

Request body

keystring required

Key of the field collection

Example request

{
  "key": "MyFieldCollection"
}

Response

Successfully created field collection definition

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 field collection definition can be written to

Example response

{
  "key": "MyFieldCollection",
  "title": "My Field Collection",
  "group": "system",
  "parentClass": "App\\Model\\DataObject\\FieldCollection",
  "implementsInterfaces": "App\\Model\\DataObject\\Interface",
  "blockedVarsForExport": [],
  "isWriteable": true
}

Changes