Class Definition

class_field_collection_update_summary

Changed on

class_field_collection_update_description

put/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

Request body

configurationobject required

Layout configuration for fields (Panel, Input, ..)

valuesobject required

Values for field collection definition metadata

Example request

{
  "configuration": {
    "children": [
      {
        "name": "Layout",
        "datatype": "layout",
        "fieldtype": "panel",
        "type": null,
        "region": "",
        "title": "Pattern",
        "width": "",
        "height": "",
        "collapsible": false,
        "collapsed": false,
        "bodyStyle": "",
        "locked": false,
        "layout": "",
        "border": false,
        "icon": null,
        "labelWidth": 100,
        "labelAlign": "left",
        "invalidFieldError": null,
        "children": [
          {
            "name": "count",
            "datatype": "data",
            "fieldtype": "numeric",
            "title": "Token Count",
            "tooltip": "",
            "mandatory": false,
            "noteditable": false,
            "index": false,
            "locked": false,
            "style": "",
            "permissions": null,
            "relationType": false,
            "invisible": false,
            "visibleGridView": false,
            "visibleSearch": false,
            "defaultValue": null,
            "integer": true,
            "unsigned": true,
            "minValue": 1,
            "maxValue": null,
            "unique": false,
            "decimalSize": null,
            "decimalPrecision": null,
            "width": 400,
            "defaultValueGenerator": "",
            "invalidFieldError": null,
            "children": null
          }
        ]
      }
    ]
  },
  "values": {
    "parentClass": "\\App\\Bundle\\Model\\MyCustomParentType",
    "implementsInterfaces": "",
    "title": "",
    "group": "Voucher",
    "blockedVarsForExport": []
  }
}

Response

class_field_collection_update_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