Skip to content

nodes_datalinks_sample_suggestions_retrieve

GET
/api/nodes/{node_pk}/datalinks/sample-suggestions
curl --request GET \
--url https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/datalinks/sample-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 SampleSuggestion.

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
sample
required

Serializer for SuggestedSample.

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
confidence
required
  • high - High
  • medium - Medium
  • low - Low
string
Allowed values: high medium low
metadata
required
Array<object>

Serializer for SuggestionMetadata.

object
id
required
string
slug
required
string
name
required
string
description
string
nullable
value

Example

{
"sample": {
"inherited": false
},
"confidence": "high"
}
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."
}
]
}