Skip to content

nodes_datalinks_metadata_suggestions_retrieve

GET
/api/nodes/{node_pk}/datalinks/metadata-suggestions
curl --request GET \
--url https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/datalinks/metadata-suggestions \
--header 'Authorization: Bearer <token>' \
--header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Return file-association suggestions for all DataLinks on a given Node.

node_pk
required
string format: uuid
X-Workspace
required
string format: uuid

Workspace ID

Media typeapplication/json

Serializer for Suggestion.

object
type
required
string
confidence
required
string
metadata
required
Array<object>

Serializer for SuggestionMetadata.

object
id
required
string
slug
required
string
name
required
string
description
string
nullable
value
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

Example generated

{
"type": "example",
"confidence": "example",
"metadata": [
{
"id": "example",
"slug": "example",
"name": "example",
"description": "example",
"value": "example"
}
],
"files": [
{
"datalink_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"data_name": "example",
"data_id": "example",
"role": "example"
}
]
}
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."
}
]
}