Sign in
Data Objects

Update a data object by ID

Changed on

You can create/update/delete list entries like properties or data object editable fields. <br> If you want to update (add/remove) only some data of a field (e.g data of multi-relation fields), use the PATCH method.

put/pimcore-studio/api/data-objects/{id}

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/{id}
  • Auth: none declared

Path parameters

idinteger required
Example:83

Id of the data-object

Request body

Example request

{
  "data": {
    "coauthorType": "agent",
    "coauthor": "product-data-agent",
    "properties": [
      {
        "key": "Mister Proper",
        "data": "123",
        "type": "document"
      }
    ]
  }
}

Response

Successfully updated data object

OR

Example response

{
  "id": 83,
  "parentId": 1,
  "path": "/path/to/element",
  "icon": {
    "type": "path",
    "value": "/path/to/icon"
  },
  "userOwner": 1,
  "userModification": 1,
  "locked": "locked",
  "creationDate": 221846400,
  "modificationDate": 327417600,
  "elementType": "asset",
  "customAttributes": {
    "icon": {
      "type": "path",
      "value": "/path/to/icon"
    },
    "tooltip": "<b>My Tooltip</b>",
    "additionalIcons": [
      "some_other_icon"
    ],
    "key": "my_custom_key",
    "additionalCssClasses": [
      "my_custom_class"
    ]
  },
  "key": "Giulietta",
  "className": "car",
  "type": "image",
  "fullPath": "/path/to/dataObject",
  "permissions": {
    "list": true,
    "view": true,
    "publish": true,
    "delete": true,
    "rename": true,
    "create": true,
    "settings": true,
    "versions": true,
    "properties": true,
    "save": true,
    "unpublish": true,
    "localizedEdit": "default",
    "localizedView": "default"
  },
  "childrenSortBy": "index",
  "childrenSortOrder": "asc",
  "objectData": {
    "fieldKey": "field value"
  },
  "inheritanceData": {
    "fieldKey": []
  },
  "draftData": {
    "id": 83,
    "modificationDate": 1634025600
  }
}

Changes

  • 81b097a1505fRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status