Documents

Get all document data for the tree

Listing of all documents and document folders in the system. <br> Returns only data which are relevant for the tree <br> You can use different query parameters to filter the assets and it is possible to exclude folders from the result completely

get/pimcore-studio/api/documents/tree

Request

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

Query parameters

pageinteger required
Example:1

Page number

pageSizeinteger required
Example:10

Number of items per page

parentIdinteger
Example:1

Filter documents by parent id.

idSearchTermstring

Filter assets/data-objects by matching ids. As a wildcard * can be used

pqlQuerystring
Example:id = 69

Pql query filter

excludeFoldersboolean

Filter folders from result.

pathstring
Example:/path/to/folder

Filter by path.

pathIncludeParentboolean
Example:true

Include the parent item in the result.

pathIncludeDescendantsboolean
Example:true

Include all descendants in the result.

Response

Paginated documents with total count as header param as JSON

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "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
      }
    }
  ]
}

Changes

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