nodes_update
const url = 'https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PUT', headers: { 'X-Workspace': '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"title":"New title","description":"<p>New description</p>"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \ --data '{ "title": "New title", "description": "<p>New description</p>" }'Update an Node item.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”A UUID string identifying this node.
Header Parameters
Section titled “Header Parameters”Workspace ID
Request Body
Section titled “Request Body”object
Node title
Node description (HTML format)
Icon identifier or URL
Node status
Parent node ID (null for root nodes)
Place this node after the specified sibling node ID. Null means place at the beginning. Cannot be used with before_node_id or position.
Place this node before the specified sibling node ID. Cannot be used with after_node_id or position.
Examples
Update title and description
{ "title": "New title", "description": "<p>New description</p>"}Move to first position
{ "after_node_id": null}Move after specific node
{ "after_node_id": "12345678-1234-1234-1234-123456789abc"}Move before specific node
{ "before_node_id": "12345678-1234-1234-1234-123456789abc"}Change parent
{ "parent": "87654321-4321-4321-4321-987654321cba"}Responses
Section titled “Responses”Serializer for Node model.
object
Return the interactor information of the object’s creator.
Parameters
obj : object The object containing the creator information.
Returns
dict The interactor information of the creator.
object
Return information about the last interactor who edited the object.
Parameters
obj : object The object containing the last editor information.
Returns
dict The interactor information of the last editor.
object
Return a list of IDs representing the path from a given object to its root parent.
Parameters
obj : object The object with an “id” attribute and a “parent” attribute.
Returns
list A list of strings representing the path from the given object to its root parent.
Return count of children for a given object and a related URL to retrieve them.
Only the children the requesting user may read are counted, so that the count matches what the related URL returns: memberships are not inherited at read time, and a node may have children hidden from the user asking for it.
Parameters
obj : object The object for which to retrieve the children.
Returns
dict A dictionary with keys “count” and “related” containing the number of children and a URL to retrieve the related children objects.
object
Return information about the samples, including the count and a related URL.
Parameters
obj : object The object for which to retrieve the sample.
Returns
dict A dictionary with keys “count” and “related” containing the number of samples and a URL to retrieve the related sample objects.
object
Return information about the datalinks, including the count and a related URL.
Parameters
obj : object The object for which to retrieve the datalink.
Returns
dict A dictionary with keys “count” and “related” containing the number of datalinks and a URL to retrieve the related datalink objects.
object
Return information about the metadata, including the count and a related URL.
Parameters
obj : object The object for which to retrieve the metadata.
Returns
dict A dictionary with keys “count” and “related” containing the number of metadata and a URL to retrieve the related metadata objects.
object
Return the role of the user in the node.
Parameters
obj : object The object for which to retrieve the member role.
Returns
str The role of the user in the node, or None if the user is not a member.
Example
{ "status": "active"}object
object
Example
{ "code": "uri_validation_error", "message": "Invalid URI parameters. Check the `details` property for more details.", "details": [ { "parameter": "node", "code": "invalid", "message": "\"<parameter_value>\" is not a valid UUID." } ]}object
object
Example
{ "code": "forbidden", "message": "You do not have permission to perform this operation. Check the `details` property for more details.", "details": [ { "parameter": "node", "code": "not_allowed", "message": "Only node owners can reorder its children." } ]}object
object
Example
{ "code": "object_not_found", "message": "Object not found. Check the `details` property for more details.", "details": [ { "parameter": "<id>", "code": "does_not_exist", "message": "\"<id>\" does not exist." } ]}
