ScopedNodeResponseDto

Example

JSON

{
  "id": "string",
  "name": "string",
  "description": "string",
  "slug": "string",
  "node_type": "string",
  "parent_node_id": "string",
  "status": "string",
  "access_state": "accessible",
  "can_access": false,
  "can_manage": false,
  "version": 0,
  "direct_count": 0,
  "inherited_count": 0
}

Properties

13 properties 13 required

id string Required

name string Required

description string Required

Optional free-text description shown under the node name.

nullable

slug string Required

node_type string Required

Org-defined node type

parent_node_id string Required

nullable

status string Required

access_state enum Required

Enumaccessiblecontext_only

can_access boolean Required

can_manage boolean Required

version number Required

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

direct_count number Required

Distinct active identities directly assigned at this node (excludes inherited).

inherited_count number Required

Distinct active identities inherited from this node's ancestors.

Was this page helpful?

Tell us how we can improve this guide.