Properties

property_update_summary

property_update_description

put/pimcore-studio/api/properties/{id}

Request

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

Path parameters

idstring required
Example:alpha-numerical

Id of the property

Request body

namestring required

name

descriptionstring nullable

description

keystring required

key

typestring required

type

datastring nullable

data

configstring nullable

config

ctypestring required

ctype

inheritableboolean required

inheritable

Example request

{
  "name": "Mister Proper",
  "description": "Detailed description of the property",
  "key": "Key for referencing",
  "type": "text",
  "data": "test",
  "config": "comma,separated,values",
  "ctype": "document"
}

Response

property_update_success_response

additionalAttributesobject

AdditionalAttributes

idstring required

id

namestring required

name

descriptionstring nullable

description

keystring required

key

typestring required

type

datastring nullable

data

configstring nullable

config

ctypestring required

ctype

inheritableboolean required

inheritable

creationDateinteger required

Creation date

modificationDateinteger required

Modification date

Example response

{
  "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.