Sign in
Data Objects

Format the path of the data

Changed on

Format the path of the data given by the <strong>{targets}</strong> option.

post/pimcore-studio/api/data-objects/format-path

Request

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

Request body

objectIdinteger required
targetsobject required
fieldNamestring

Fieldname for the PathFormatter. Given as Dot Notation

Example request

{
  "objectId": 1,
  "fieldName": "attributes.Bodywork.numberOfDoors"
}

Response

Formatted path of the objects

totalItemsinteger required

Example response

{
  "totalItems": 666
}

Changes

  • 81b097a1505fRevision changes
    • breaking

      response property items/items/formatedPath list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property items/items/objectReference list-of-types was widened by adding types integer to media type application/json of response 200