Sign in
Documents

document_update_by_id_summary

document_update_by_id_description

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

Request

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

Path parameters

idinteger required
Example:83

Id of the document

Request body

Example request

{
  "data": {
    "settingsData": {
      "title": "Some Title",
      "description": "Some Description",
      "prettyUrl": "pretty/url",
      "controller": "App\\Controller\\PageController",
      "template": "@app/template.html.twig",
      "contentMainDocumentId": 123,
      "contentMainDocumentPath": "/path/to/main/document",
      "supportsContentMain": false,
      "missingRequiredEditable": false,
      "staticGeneratorEnabled": false,
      "staticGeneratorLifetime": 123456,
      "staticLastGenerated": 1700000000,
      "url": "https://example.com/"
    },
    "properties": [
      {
        "key": "Mister Proper",
        "data": "123",
        "type": "document"
      }
    ]
  }
}

Response

document_update_by_id_success_response

idinteger required

ID

parentIdinteger required

ID of parent

pathstring required

path

userOwnerinteger required

ID of owner

userModificationinteger nullable required

User that modified the element

lockedstring nullable required

Locked

isLockedboolean required

Is locked

creationDateinteger nullable required

Creation date

modificationDateinteger nullable required

Modification date

elementTypestring required

elementType

additionalAttributesobject

AdditionalAttributes

fullPathstring required

Full path

publishedboolean required

Published

typestring required

Type

keystring required

Key

indexinteger required

Custom index

hasChildrenboolean required

Has children

hasWorkflowWithPermissionsboolean required

Workflow permissions

isSiteboolean required

Is document a site

navigationExcludeboolean required

Exclude document from navigation

editableDataobject required

Document Editable Data

missingRequiredEditableboolean required

Is missing required editable

settingsDataobject required

Document Settings Data

hasWorkflowAvailableboolean required

Has workflow available

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"
    ]
  },
  "fullPath": "/path/to/document",
  "type": "link",
  "key": "page.html",
  "permissions": {
    "list": true,
    "view": true,
    "publish": true,
    "delete": true,
    "rename": true,
    "create": true,
    "settings": true,
    "versions": true,
    "properties": true,
    "save": true,
    "unpublish": true
  },
  "editableData": {
    "editable": "value"
  },
  "settingsData": {
    "title": "Some Title",
    "description": "Some Description",
    "prettyUrl": "pretty/url",
    "controller": "App\\Controller\\PageController",
    "template": "@app/template.html.twig",
    "contentMainDocumentId": 123,
    "contentMainDocumentPath": "/path/to/main/document",
    "supportsContentMain": false,
    "missingRequiredEditable": false,
    "staticGeneratorEnabled": false,
    "staticGeneratorLifetime": 123456,
    "staticLastGenerated": 1700000000,
    "url": "https://example.com/"
  },
  "draftData": {
    "id": 83,
    "modificationDate": 1634025600
  }
}

Changes

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