Class Definition

Get field collection by key

Changed on

Retrieves a specific field collection definition based on the given <strong>{key}</strong>. <br> The <strong>{key}</strong> must be the key of an existing field collection definition.

get/pimcore-studio/api/class/field-collection/{key}

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/{key}
  • Auth: none declared

Path parameters

keystring required
Example:MyFieldCollection

Field collection unique key

Response

Field collection detail data

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