NodeMovePreviewDto

Example

JSON

{
  "blockers": [
    {
      "code": "hierarchy.reparent_cycle",
      "message": "string"
    }
  ],
  "people_named": false,
  "identities_gaining": 0,
  "identities_losing": 0,
  "permissions": [
    {
      "permission": "string",
      "gaining": 0,
      "losing": 0
    }
  ],
  "people": {
    "items": [
      {
        "identity": {
          "id": "string",
          "first_name": "string",
          "last_name": "string",
          "name": "string",
          "email": "string",
          "avatar_url": "string"
        },
        "gained": [
          "string"
        ],
        "lost": [
          "string"
        ],
        "via": [
          {
            "role": {
              "id": null,
              "name": null
            },
            "node": {
              "id": null,
              "name": null
            }
          }
        ]
      }
    ],
    "pagination": {
      "page": 0,
      "take": 0,
      "item_count": 0,
      "page_count": 0,
      "has_previous_page": false,
      "has_next_page": false
    }
  },
  "node_id": "string",
  "parent_node_id": "string",
  "version": 0,
  "parent_version": 0,
  "subtree_size": 0,
  "invites": {
    "total": 0,
    "names": [
      "string"
    ]
  },
  "directory_groups": {
    "total": 0,
    "names": [
      "string"
    ]
  }
}

Properties

13 properties 13 required

blockers array of PreviewBlockerDto Required

What would refuse the change. When any is listed, nothing below is resolved

people_named boolean Required

Whether people are named: false for a reader who may not see the Environment's people, who gets the counts and no list

identities_gaining number Required

Holders who gain at least one permission

identities_losing number Required

Holders who lose at least one permission

permissions array of PermissionChangeCountDto Required

people object Required

One page of the people the change reaches. The counts above cover everyone; the page follows the query

node_id string Required

parent_node_id string Required

version number Required

The node's version now: send it as `If-Match` on the move

parent_version number Required

The destination's version now: send it as `parent_version` on the move

subtree_size number Required

The node and every node beneath it

invites object Required

Pending invitations to nodes in the subtree, which move with it, by email (none listed unless `people_named`)

directory_groups object Required

Directory groups mapped to nodes in the subtree, which move with it, by name

Was this page helpful?

Tell us how we can improve this guide.