nodes

The asset hierarchy - nodes, their children, paths, rights and search.

📄️Get the root nodes

Returns all nodes of type ROOT (usually the single tree root), with the root icon applied.

📄️Get a node by its reference id

Looks up and returns the node whose reference id matches the given value, or responds 404 if no such node exists.

📄️Search nodes by name

Returns all non-deleted nodes whose name contains the given search string (case-insensitive substring match).

📄️Get a node by id

Returns the single node with the given id, or responds 404 if it does not exist.

📄️Delete a node and its subtree

Soft-deletes the node and all of its descendants, marking the underlying assets, signals and dashboards as deleted. Rejects deleting signal nodes that belong to a form or signal group.

📄️Move a node to a new parent

Moves the node under the parent supplied in the body, recomputing the parent-id and parent-name paths of the node and all its descendants. Enforces valid move targets. Returns the moved node only, not its subtree: the paths of the descendants are rewritten in the database, but returning them made the answer grow with the tree without a client being able to use it. A client holding a cached subtree has to discard it and load it again.

📄️Map reference ids to node ids

Given a list of reference ids, returns a map from each reference id to the id of its corresponding node.

📄️Get reference metadata for a node

Returns metadata for the node identified by the reference id, including its parent name path and a map of output ids to their names.

📄️Get a node's path as a string

Returns the node's full parent name path as a single human-readable string.

📄️Get assignable group rights for a node

For the supplied group names, returns a map of group name to the most relevant access right effective on the node's parent (or read for a root node), i.e. the maximum right that may be assigned on this node.

📄️Get assignable user rights for a node

For the supplied user names, returns a map of user name to the most relevant access right effective on the node's parent (or read for a root node), i.e. the maximum right that may be assigned on this node.

📄️Get group rights of a node

Returns the group access rights directly assigned to the given node.

📄️Delete all group rights of a node

Removes all group access-right assignments for the given node.

📄️Get effective user rights of a node

Computes for every user the effective access right on the node, combining directly assigned user rights with rights inherited through their groups. Returns one entry per user that has any effective right, noting the node it was inherited from.

📄️Get user rights of a node

Returns the user access rights directly assigned to the given node.

📄️Delete all user rights of a node

Removes all user access-right assignments for the given node.

📄️Get a node's children

Returns the child nodes of the given parent: only direct children by default, or the entire descendant subtree when recursive is set.

📄️Get paginated children of a node

Returns a page of the node's children, optionally recursing into descendants and filtering by name, path and node type. The response includes the current page, the page items and the total item count.

📄️Get a node's ancestors

Returns all ancestor nodes from the given node up to the root, optionally also including the siblings of those ancestors.

📄️Check for edit rights on any asset

Returns a flag indicating whether the caller has more than read-only access to at least one asset or the root in the explorer.