Class Definition

Update a select option configuration

Changed on

Update an existing select option configuration. Replaces the configuration data with the provided values. Admin-only configurations require admin access.

put/pimcore-studio/api/class/select-option/{id}

Request

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

Path parameters

idstring required
Example:EventStatus

Select option configuration ID

Request body

groupstring nullable required

Group name

adminOnlyboolean required

Whether this configuration is restricted to admin

useTraitsstring required

PHP traits to use

implementsInterfacesstring required

PHP interfaces to implement

Example request

{
  "group": "system",
  "selectOptions": [
    {
      "value": "active",
      "label": "Active",
      "name": "Active"
    }
  ]
}

Response

Updated select option configuration detail

additionalAttributesobject

AdditionalAttributes

idstring required

ID of the select options configuration

groupstring nullable required

Group name

adminOnlyboolean required

Whether this configuration is restricted to admin

useTraitsstring required

PHP traits to use

implementsInterfacesstring required

PHP interfaces to implement

enumNamestring required

Fully qualified enum name

isWriteableboolean required

Whether the configuration is writeable

Example response

{
  "id": "EventStatus",
  "group": "system",
  "selectOptions": [
    {
      "value": "active",
      "label": "Active",
      "name": "Active"
    }
  ],
  "enumName": "Pimcore\\Model\\DataObject\\SelectOptions\\EventStatus",
  "isWriteable": true
}

Changes