Sign in
Class Definition

class_field_collection_get_by_key_summary

Changed on

class_field_collection_get_by_key_description

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

class_field_collection_get_by_key_success_response

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