Skip to content

nodes_suggestions_create

POST
/api/nodes/{id}/suggestions
curl --request POST \
--url https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/suggestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--data '{ "title": "example", "description": "example", "icon": "example", "status": "active", "workspace": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "parent": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Bulk apply a list of groups to a node.

id
required
string format: uuid

A UUID string identifying this node.

X-Workspace
required
string format: uuid

Workspace ID

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
Media typeapplication/json

Serializer for BundleSuggestion.

object
files
required
Array<object>

Serializer for SuggestedFile.

object
datalink_id
required
string format: uuid
data_name
required
string
data_id
required
string
role
required
string
nullable
confidence
required

Serializer for ComponentConfidence.

object
association
required
One of:
  • high - High
  • medium - Medium
  • low - Low
string
Allowed values: high medium low
sample
required
One of:
  • high - High
  • medium - Medium
  • low - Low
string
Allowed values: high medium low
metadata
required
One of:
  • high - High
  • medium - Medium
  • low - Low
string
Allowed values: high medium low
overall
required
  • high - High
  • medium - Medium
  • low - Low
string
Allowed values: high medium low
association
required
object
association_id
string
nullable
exists
required
boolean
sample
required
object
sample_id
required
string format: uuid
nullable
proposed_alias
required
string
exists
required
boolean
already_bound
required
boolean
node_id
string format: uuid
nullable
inherited
boolean
metadata
required
Array<object>

Serializer for BundleMetadataItem.

object
slug
required
string
name
required
string
value
required
description
string
nullable
confidence
required
  • high - High
  • medium - Medium
  • low - Low
string
Allowed values: high medium low
target
required
  • data - data
  • association - association
  • sample - sample
string
Allowed values: data association sample

Example

{
"confidence": {
"association": "high",
"sample": "high",
"metadata": "high",
"overall": "high"
},
"sample": {
"inherited": false
},
"metadata": [
{
"confidence": "high",
"target": "data"
}
]
}
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",
"message": "Not a member of the node.",
"code": "unauthorized"
}
]
}
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."
}
]
}