Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Structure Links

delete

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.

Query parameters
source_external_idstringRequired

Source data structure external ID

target_external_idstringRequired

Target data structure external ID

Responses
204

Data structure link deleted

No content

delete/api/data_structure_links/search_delete_one
DELETE /api/data_structure_links/search_delete_one?source_external_id=text&target_external_id=text HTTP/1.1
Accept: */*

No content

get

Lists the links for a data structure, restricted to the links visible to the current user.

Path parameters
data_structure_idintegerRequired

Data structure ID

Responses
200

Data structure links

application/json
get/api/data_structures/{data_structure_id}/structure_links
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"
    }
  ]
}

Create data structure link

post

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.

Body

Request to create one or multiple data structure links

or
Responses
201

Data structure link created

application/json

Response for data structure link creation (single or bulk)

or
post/api/data_structure_links
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"
  }
}
get

Lists the links for a data structure identified by its external ID, restricted to the links visible to the current user.

Query parameters
external_idstringRequired

Data structure external ID

Responses
200

Data structure links

application/json
get/api/data_structure_links/search_all
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"
    }
  ]
}
get

Retrieves a data structure link by source and target external IDs.

Requires the 'View structures' permission for both related structures.

Query parameters
source_external_idstringRequired

Source data structure external ID

target_external_idstringRequired

Target data structure external ID

Responses
200

Data structure link

application/json
get/api/data_structure_links/search_one
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"
  }
}
get

Retrieves a single data structure link by source and target IDs.

Requires the 'View structures' permission for both the source and target structures.

Path parameters
source_idintegerRequired

Source data structure ID

target_idintegerRequired

Target data structure ID

Responses
200

Data structure link

application/json
get/api/data_structures/structure_links/source/{source_id}/target/{target_id}
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"
  }
}
delete

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.

Path parameters
source_idintegerRequired

Source data structure ID

target_idintegerRequired

Target data structure ID

Responses
204

Data structure link deleted

No content

delete/api/data_structures/structure_links/source/{source_id}/target/{target_id}
DELETE /api/data_structures/structure_links/source/{source_id}/target/{target_id} HTTP/1.1
Accept: */*

No content

Search data structure links

post

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.

Body
pageintegerOptionalDefault: 0
scroll_idstring · nullableOptional
sincestring · nullableOptional
sizeintegerOptionalDefault: 50
Responses
200

Data structure links search

application/json
scroll_idstring · nullableOptional
post/api/data_structure_links/search
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