Sign in
Data Objects

data_object_format_path_summary

data_object_format_path_description

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

data_object_format_path_success_response

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "objectReference": "object_11",
      "formatedPath": "nice/path"
    }
  ]
}

Changes

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