1. Docs
  2. API Reference
  3. HierarchyTreeNodeDto

The HierarchyTreeNodeDto object

Example 

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "node_type": "string",
  "parent_node_id": "string",
  "status": "string",
  "access_state": "accessible",
  "can_access": false,
  "can_manage": false,
  "children": [
    {
      "id": "string",
      "name": "string",
      "slug": "string",
      "node_type": "string",
      "parent_node_id": "string",
      "status": "string",
      "access_state": "accessible",
      "can_access": false,
      "can_manage": false,
      "children": [
        {
          "id": "string",
          "name": "string",
          "slug": "string",
          "node_type": "string",
          "parent_node_id": "string",
          "status": "string",
          "access_state": "accessible",
          "can_access": false,
          "can_manage": false,
          "children": [
            {
              "id": "string",
              "name": "string",
              "slug": "string",
              "node_type": "string",
              "parent_node_id": "string",
              "status": "string",
              "access_state": "accessible",
              "can_access": false,
              "can_manage": false,
              "children": [
                {
                  "id": null,
                  "name": null,
                  "slug": null,
                  "node_type": null,
                  "parent_node_id": null,
                  "status": null,
                  "access_state": null,
                  "can_access": null,
                  "can_manage": null,
                  "children": null,
                  "version": null
                }
              ],
              "version": 0
            }
          ],
          "version": 0
        }
      ],
      "version": 0
    }
  ],
  "version": 0
}

Properties

  • idstring*
  • namestring*
  • slugstring*
  • node_typestring*

    Org-defined node type

  • parent_node_idstring*
  • statusstring*
  • access_stateenum: "accessible" | "context_only"*
  • can_accessboolean*
  • can_manageboolean*
  • childrenHierarchyTreeNodeDto[]*
  • versionnumber*

    Optimistic-lock version. Send back as the `If-Match` header when mutating this node to detect concurrent edits.

Canopy