Data Structure Links

Delete data structure link by external ids

delete

Deletes a data structure link identified by source and target external IDs.

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

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

delete/api/data_structure_links/search_delete_one

HTTPcURLJavaScriptPython

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

No content

List links by data structure ID

get

Lists links for a data structure, filtered by the current user's visibility.

Path parameters

data_structure_idintegerRequired

Data structure ID

Responses

200

Data structure links

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/data_structures/{data_structure_id}/structure_links

HTTPcURLJavaScriptPython

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 a new data structure link or bulk loads links depending on the payload.

Body

application/json

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

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/data_structure_links

HTTPcURLJavaScriptPython

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"
  }
}

List links by external ID

get

Lists links for a data structure identified by its external ID, filtered by user visibility.

Query parameters

external_idstringRequired

Data structure external ID

Responses

200

Data structure links

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/data_structure_links/search_all

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Show data structure link by external ids

get

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

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

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/data_structure_links/search_one

HTTPcURLJavaScriptPython

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"
  }
}

Show link by source and target IDs

get

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

Path parameters

source_idintegerRequired

Source data structure ID

target_idintegerRequired

Target data structure ID

Responses

200

Data structure link

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/data_structures/structure_links/source/{source_id}/target/{target_id}

HTTPcURLJavaScriptPython

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 data structure link

delete

Deletes the data structure link identified by source and target IDs.

Path parameters

source_idintegerRequired

Source data structure ID

target_idintegerRequired

Target data structure ID

Responses

204

Data structure link deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

delete/api/data_structures/structure_links/source/{source_id}/target/{target_id}

HTTPcURLJavaScriptPython

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.

Body

application/json

pageintegerOptionalDefault: 0

scroll_idstring · nullableOptional

sincestring · nullableOptional

sizeintegerOptionalDefault: 50

Responses

200

Data structure links search

application/json

scroll_idstring · nullableOptional

401

Unauthorized

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/data_structure_links/search

HTTPcURLJavaScriptPython

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
}