Data Structure Links
Deletes a data structure link identified by source and target external IDs.
Requires the 'Link structure to structure' permission for both endpoint domains and returns no content when successful.
Source data structure external ID
Target data structure external ID
Data structure link deleted
No content
Unauthorized
Forbidden
Not found
Internal Server Error
DELETE /api/data_structure_links/search_delete_one?source_external_id=text&target_external_id=text HTTP/1.1
Accept: */*
No content
Lists the links for a data structure, restricted to the links visible to the current user.
Data structure ID
Data structure links
Unauthorized
Internal Server Error
GET /api/data_structures/{data_structure_id}/structure_links HTTP/1.1
Accept: */*
{
"data": [
{
"id": 1,
"inserted_at": "2026-06-11T10:00:00Z",
"labels": [
"label"
],
"source": {
"external_id": "ds_source",
"id": 10
},
"target": {
"external_id": "ds_target",
"id": 20
},
"updated_at": "2026-06-11T10:00:00Z"
}
]
}Creates one link when the request contains data_structure_link, or bulk loads links when it contains data_structure_links.
Single creation uses numeric source and target IDs and optional label_ids; it requires Link structure to structure for both endpoint domains.
Bulk creation uses source and target external IDs and optional label_names; it requires the Link structure to structure permission.
Request to create one or multiple data structure links
Data structure link created
Response for data structure link creation (single or bulk)
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
POST /api/data_structure_links HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"data_structure_link": {
"label_ids": [
10,
20
],
"source_id": 1,
"target_id": 2
}
}{
"data": {
"id": 123,
"inserted_at": "2026-01-01T00:00:00Z",
"labels": [
"label1",
"label2"
],
"source_id": 1,
"target_id": 2,
"updated_at": "2026-01-01T00:00:00Z"
}
}Lists the links for a data structure identified by its external ID, restricted to the links visible to the current user.
Data structure external ID
Data structure links
Unauthorized
Internal Server Error
GET /api/data_structure_links/search_all?external_id=text HTTP/1.1
Accept: */*
{
"data": [
{
"id": 1,
"inserted_at": "2026-06-11T10:00:00Z",
"labels": [
"label"
],
"source": {
"external_id": "ds_source",
"id": 10
},
"target": {
"external_id": "ds_target",
"id": 20
},
"updated_at": "2026-06-11T10:00:00Z"
}
]
}Retrieves a data structure link by source and target external IDs.
Requires the 'View structures' permission for both related structures.
Source data structure external ID
Target data structure external ID
Data structure link
Unauthorized
Forbidden
Not found
Internal Server Error
GET /api/data_structure_links/search_one?source_external_id=text&target_external_id=text HTTP/1.1
Accept: */*
{
"data": {
"id": 1,
"inserted_at": "2026-06-11T10:00:00Z",
"labels": [
"label"
],
"source": {
"external_id": "ds_source",
"id": 10
},
"target": {
"external_id": "ds_target",
"id": 20
},
"updated_at": "2026-06-11T10:00:00Z"
}
}Retrieves a single data structure link by source and target IDs.
Requires the 'View structures' permission for both the source and target structures.
Source data structure ID
Target data structure ID
Data structure link
Unauthorized
Forbidden
Not found
Internal Server Error
GET /api/data_structures/structure_links/source/{source_id}/target/{target_id} HTTP/1.1
Accept: */*
{
"data": {
"id": 1,
"inserted_at": "2026-06-11T10:00:00Z",
"labels": [
"label"
],
"source": {
"external_id": "ds_source",
"id": 10
},
"target": {
"external_id": "ds_target",
"id": 20
},
"updated_at": "2026-06-11T10:00:00Z"
}
}Deletes the data structure link identified by source and target IDs.
Requires the 'Link structure to structure' permission for both endpoint domains and returns no content when successful.
Source data structure ID
Target data structure ID
Data structure link deleted
No content
Unauthorized
Forbidden
Not found
Unprocessable Entity
Internal Server Error
DELETE /api/data_structures/structure_links/source/{source_id}/target/{target_id} HTTP/1.1
Accept: */*
No content
Searches data structure links using the provided filters and returns only links visible to the authenticated user.
Requires the 'View structures' permission for both endpoints.
050Data structure links search
Unauthorized
Unprocessable Entity
Internal Server Error
POST /api/data_structure_links/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"page": 0,
"since": "2026-06-10T10:00:00Z",
"size": 20
}{
"data_structure_links": [],
"scroll_id": null
}Last updated