Properties

Get all predefined properties. You can filter by type and query

Listing all the predefined properties that are currently stored in the system. <br> To list specific properties for a type you can use the <strong>elementType</strong> query parameter.<br> You can also created element type specific listings for this, to show in the context of the element. <br> The <strong>filter</strong> query parameter is applied on the string properties. <br> Keep in mind that the name is language specific.

get/pimcore-studio/api/properties

Request

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

Query parameters

elementType'asset' | 'document' | 'data-object'
Example:data-object

Filter elements by matching element type.

filterstring
Example:properties

Filter for properties

Response

Predefined properties filtered based on type and query parameters

Example response

{
  "items": [
    {
      "id": "alpha-numerical-value",
      "name": "Mister Proper",
      "description": "Detailed description of the property",
      "key": "Key for referencing",
      "type": "text",
      "data": "test",
      "config": "comma,separated,values",
      "ctype": "document",
      "creationDate": 221846400,
      "modificationDate": 327417600
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.