Sign in
Class Definition

Get collection of all class definitions that can be created.

Get collection of all class definitions that can be created.

get/pimcore-studio/api/class/collection/creatable

Request

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

Query parameters

widgetIdstring
Example:object_tree

Optional element tree widget ID to filter classes by the widget's allowed classes configuration

Response

List of class definitions that can be created.

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "id": "AP",
      "name": "AccessoryPart",
      "title": "Accessory Part",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "group": "system"
    }
  ]
}

Changes