Properties

property_get_collection_summary

property_get_collection_description

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

property_get_collection_success_response

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.