> For the complete documentation index, see [llms.txt](https://docs.truedat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.truedat.io/api-integrations/business-glossary-apis/links.md).

# Links

## Download business concept links XLSX

> Exports the concept‑to‑structure links visible to the caller as an Excel (XLSX) workbook.\
> \
> \*\*Permissions:\*\*\
> Requires the \*\*'Manage business concept links'\*\* permission. The check is global rather than per‑domain; once granted, the export includes all links the caller can see in the domains they have access to.\
> \
> \*\*Workbook columns:\*\*\
> \- \`id\`, \`current\_version\`, \`concept\_name\`, \`concept\_type\`, \`domain\_external\_id\`, \`domain\_name\`, \`structure\_external\_id\`, \`structure\_name\`, \`structure\_system\`, \`path\`, \`link\_type\`.\
> \- \`concept\_type\` – The template's name (not the label).\
> \- \`link\_type\` – The relationship code as defined (not a translated label).\
> \
> The language used for the export is taken from the request locale. Pagination is not applied; the full set of visible links is exported.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concept_versions/links/download":{"post":{"description":"Exports the concept‑to‑structure links visible to the caller as an Excel (XLSX) workbook.\n\n**Permissions:**\nRequires the **'Manage business concept links'** permission. The check is global rather than per‑domain; once granted, the export includes all links the caller can see in the domains they have access to.\n\n**Workbook columns:**\n- `id`, `current_version`, `concept_name`, `concept_type`, `domain_external_id`, `domain_name`, `structure_external_id`, `structure_name`, `structure_system`, `path`, `link_type`.\n- `concept_type` – The template's name (not the label).\n- `link_type` – The relationship code as defined (not a translated label).\n\nThe language used for the export is taken from the request locale. Pagination is not applied; the full set of visible links is exported.\n","operationId":"TdBgWeb.BusinessConceptLinkController.download","parameters":[{"description":"Full‑text search query","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by domain ID","in":"query","name":"domain_id","required":false,"schema":{"type":"string"}},{"description":"Additional filters (JSON object)","explode":true,"in":"query","name":"filters","required":false,"schema":{"additionalProperties":true,"type":"object"},"style":"deepObject"},{"description":"Sort field(s)","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"format":"binary","type":"string"}}},"description":"XLSX file downloaded"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Download business concept links XLSX","tags":["Links"]}}},"components":{"schemas":{"TdBgUnauthorizedResponse":{"properties":{"errors":{"properties":{"message":{"type":"string"}},"type":"object"}},"title":"TdBgUnauthorizedResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Create structure link action endpoint

> Hypermedia action endpoint for creating a structure link.\
> \
> The action is exposed in the business concept version hypermedia response only when the caller holds \*\*'Manage business concept links'\*\* on the concept's domains.\
> \
> The endpoint only acknowledges the action request; it does not create or return a link.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concept_versions/{business_concept_version_id}/links/structures":{"post":{"description":"Hypermedia action endpoint for creating a structure link.\n\nThe action is exposed in the business concept version hypermedia response only when the caller holds **'Manage business concept links'** on the concept's domains.\n\nThe endpoint only acknowledges the action request; it does not create or return a link.\n","operationId":"TdBgWeb.BusinessConceptLinkController.create_structure_link","parameters":[{"description":"Business concept version ID","in":"path","name":"business_concept_version_id","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted structure link action"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Create structure link action endpoint","tags":["Links"]}}},"components":{"schemas":{"TdBgUnauthorizedResponse":{"properties":{"errors":{"properties":{"message":{"type":"string"}},"type":"object"}},"title":"TdBgUnauthorizedResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Suggest structure link action endpoint

> Hypermedia action endpoint for suggesting a structure link.\
> \
> \*\*Permissions:\*\* The action is exposed in the business concept version hypermedia response only when:\
> \- the caller holds \*\*'Manage business concept links'\*\* on the concept's domains,\
> \- the caller holds \*\*'Request links AI suggestions'\*\* on the concept's domains,\
> \- the suggestions index is enabled for the tenant.\
> \
> The endpoint only acknowledges the action request; it does not return suggestion data.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concept_versions/{business_concept_version_id}/links/structures/suggest":{"post":{"description":"Hypermedia action endpoint for suggesting a structure link.\n\n**Permissions:** The action is exposed in the business concept version hypermedia response only when:\n- the caller holds **'Manage business concept links'** on the concept's domains,\n- the caller holds **'Request links AI suggestions'** on the concept's domains,\n- the suggestions index is enabled for the tenant.\n\nThe endpoint only acknowledges the action request; it does not return suggestion data.\n","operationId":"TdBgWeb.BusinessConceptLinkController.suggest_structure_link","parameters":[{"description":"Business concept version ID","in":"path","name":"business_concept_version_id","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted structure link suggestion"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Suggest structure link action endpoint","tags":["Links"]}}},"components":{"schemas":{"TdBgUnauthorizedResponse":{"properties":{"errors":{"properties":{"message":{"type":"string"}},"type":"object"}},"title":"TdBgUnauthorizedResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Create concept link action endpoint

> Hypermedia action endpoint for creating a concept link.\
> \
> The action is exposed in the business concept version hypermedia response only when the caller holds \*\*'Manage business concept links'\*\* on the concept's domain.\
> \
> The endpoint only acknowledges the action request; link creation is performed by the client flow represented by the returned action. It does not create or return a link.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concept_versions/{business_concept_version_id}/links/concepts":{"post":{"description":"Hypermedia action endpoint for creating a concept link.\n\nThe action is exposed in the business concept version hypermedia response only when the caller holds **'Manage business concept links'** on the concept's domain.\n\nThe endpoint only acknowledges the action request; link creation is performed by the client flow represented by the returned action. It does not create or return a link.\n","operationId":"TdBgWeb.BusinessConceptLinkController.create_concept_link","parameters":[{"description":"Business concept version ID","in":"path","name":"business_concept_version_id","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Accepted concept link action"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Create concept link action endpoint","tags":["Links"]}}},"components":{"schemas":{"TdBgUnauthorizedResponse":{"properties":{"errors":{"properties":{"message":{"type":"string"}},"type":"object"}},"title":"TdBgUnauthorizedResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Delete business concept link

> Deletes an existing link between a business concept and a target resource.\
> \
> \*\*Permissions:\*\* The exact permission depends on the link's target type:\
> \- \*\*Links to data structures\*\* require \*\*'Manage business concept links'\*\* on the concept's domains.\
> \- \*\*Links to implementations\*\* require \*\*'Link implementations to concepts'\*\* on the implementation's domain.\
> \- \*\*Other links\*\* (for example, concept‑to‑concept) require \*\*'Manage business concept links'\*\* on the link's domain.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concept_versions/{business_concept_version_id}/links/{id}":{"delete":{"description":"Deletes an existing link between a business concept and a target resource.\n\n**Permissions:** The exact permission depends on the link's target type:\n- **Links to data structures** require **'Manage business concept links'** on the concept's domains.\n- **Links to implementations** require **'Link implementations to concepts'** on the implementation's domain.\n- **Other links** (for example, concept‑to‑concept) require **'Manage business concept links'** on the link's domain.\n","operationId":"TdBgWeb.BusinessConceptLinkController.delete","parameters":[{"description":"Business concept version ID","in":"path","name":"business_concept_version_id","required":true,"schema":{"type":"integer"}},{"description":"Business concept link ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Business concept link deleted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgForbiddenResponse"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BGUnprocessableEntityArrayOrObjectResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Delete business concept link","tags":["Links"]}}},"components":{"schemas":{"TdBgUnauthorizedResponse":{"properties":{"errors":{"properties":{"message":{"type":"string"}},"type":"object"}},"title":"TdBgUnauthorizedResponse","type":"object"},"TdBgForbiddenResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgForbiddenResponse","type":"object"},"BGUnprocessableEntityArrayOrObjectResponse":{"description":"Response for 422 errors. Errors value might be an array or an object","oneOf":[{"$ref":"#/components/schemas/TdBgUnprocessableEntityArrayResponse"},{"$ref":"#/components/schemas/TdBgUnprocessableEntityObjectResponse"}],"title":"BGUnprocessableEntityArrayOrObjectResponse"},"TdBgUnprocessableEntityArrayResponse":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"title":"TdBgUnprocessableEntityArrayResponse","type":"object"},"TdBgUnprocessableEntityObjectResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgUnprocessableEntityObjectResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```
