Class Definition

Create a new select option configuration

Changed on

Create a new select option configuration. The ID must be unique (case-insensitive). Returns the newly created configuration detail.

post/pimcore-studio/api/class/select-option

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
  • Auth: none declared

Request body

idstring required

ID of the select options configuration

Example request

{
  "id": "EventStatus"
}

Response

Newly created 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