Skip to content

nodes_update

PUT
/api/nodes/{id}
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.

id
required
string format: uuid

A UUID string identifying this node.

X-Workspace
required
string format: uuid

Workspace ID

Media typeapplication/json
object
title

Node title

string
description

Node description (HTML format)

string
icon

Icon identifier or URL

string
status

Node status

string
Allowed values: pending published in progress
parent

Parent node ID (null for root nodes)

string format: uuid
nullable
after_node_id

Place this node after the specified sibling node ID. Null means place at the beginning. Cannot be used with before_node_id or position.

string format: uuid
nullable
before_node_id

Place this node before the specified sibling node ID. Cannot be used with after_node_id or position.

string format: uuid

Examples

Update title and description

{
"title": "New title",
"description": "<p>New description</p>"
}
Media typeapplication/json

Serializer for Node model.

object
id
required
string format: uuid
title
string
nullable <= 1000 characters
description
nullable
icon
string
nullable <= 1000 characters
status
One of:
  • active - active
  • in progress - in progress
  • archived - archived
  • pending - pending
string
Allowed values: active in progress archived pending
created_by
required

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
key
additional properties
created_time
required
string format: date-time
last_edited_by
required

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
key
additional properties
last_edited_time
required
string format: date-time
workspace
string format: uuid
path
required

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.

Array
parent
string format: uuid
nullable
children
required

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
key
additional properties
position
required
integer
samples
required

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
key
additional properties
datalinks
required

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
key
additional properties
metadata
required

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
key
additional properties
member_role
required

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.

string

Example

{
"status": "active"
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

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."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

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."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

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."
}
]
}