> 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/business-concepts.md).

# Business Concepts

## Reindex all business concepts

> Starts asynchronous reindexing of all business concepts.\
> \
> This endpoint is available only to authenticated administrators.\
> \
> The accepted response confirms that the process was queued; it does not indicate completion.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concepts/search/reindex_all":{"get":{"description":"Starts asynchronous reindexing of all business concepts.\n\nThis endpoint is available only to authenticated administrators.\n\nThe accepted response confirms that the process was queued; it does not indicate completion.\n","operationId":"TdBgWeb.SearchController.reindex_all","parameters":[],"responses":{"202":{"description":"Reindex process accepted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgForbiddenResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Reindex all business concepts","tags":["Business Concepts"]}}},"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"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Generate embeddings for all business concepts

> Starts asynchronous generation of vector embeddings for all business concepts.\
> \
> This endpoint is available only to authenticated administrators and only when the suggestions index is enabled.\
> \
> The accepted response confirms that processing was queued; it does not indicate completion.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concepts/search/embeddings/_put":{"post":{"description":"Starts asynchronous generation of vector embeddings for all business concepts.\n\nThis endpoint is available only to authenticated administrators and only when the suggestions index is enabled.\n\nThe accepted response confirms that processing was queued; it does not indicate completion.\n","operationId":"TdBgWeb.SearchController.embeddings","parameters":[],"responses":{"202":{"description":"Reindex process accepted"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgForbiddenResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Generate embeddings for all business concepts","tags":["Business Concepts"]}}},"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"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Share business concept with domains

> Replaces the domains with which the business concept is shared.\
> \
> Requires the \*\*'Share business concept with domain'\*\* permission on the concept's domain. When the concept is confidential, the caller must additionally hold \*\*'Manage confidential business concepts'\*\* on the same domain.\
> \
> \*\*Request body:\*\*\
> \- \`domain\_ids\` (required, array of integers) – Domains to share the concept with. Pass an empty array to remove all sharing.\
> \
> No additional check is performed on the target domains; sharing simply replaces the \`shared\_to\` list with the given domains.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concepts/{business_concept_id}/shared_domains":{"put":{"description":"Replaces the domains with which the business concept is shared.\n\nRequires the **'Share business concept with domain'** permission on the concept's domain. When the concept is confidential, the caller must additionally hold **'Manage confidential business concepts'** on the same domain.\n\n**Request body:**\n- `domain_ids` (required, array of integers) – Domains to share the concept with. Pass an empty array to remove all sharing.\n\nNo additional check is performed on the target domains; sharing simply replaces the `shared_to` list with the given domains.\n","operationId":"TdBgWeb.SharedDomainController.update","parameters":[{"description":"Business concept ID","in":"path","name":"business_concept_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedDomainUpdateRequest"}}},"description":"Shared domain payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedDomainUpdateResponse"}}},"description":"Business concept updated"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgForbiddenResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgNotFoundResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Share business concept with domains","tags":["Business Concepts"]}}},"components":{"schemas":{"SharedDomainUpdateRequest":{"additionalProperties":false,"properties":{"domain_ids":{"description":"IDs of the domains with which the business concept should be shared. Sending an empty list removes the current domain sharing.","items":{"type":"integer"},"type":"array"}},"required":["domain_ids"],"title":"SharedDomainUpdateRequest","type":"object"},"SharedDomainUpdateResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SharedBusinessConceptData"}},"required":["data"],"title":"SharedDomainUpdateResponse","type":"object"},"SharedBusinessConceptData":{"additionalProperties":false,"properties":{"_embedded":{"$ref":"#/components/schemas/EmbeddedSharedDomains"},"id":{"description":"Business concept ID","type":"integer"},"name":{"description":"Business concept name","nullable":true,"type":"string"},"updated_at":{"description":"Last update timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["id","_embedded"],"title":"SharedBusinessConceptData","type":"object"},"EmbeddedSharedDomains":{"additionalProperties":false,"properties":{"shared_to":{"description":"List of domains the concept is shared with","items":{"$ref":"#/components/schemas/Domain"},"type":"array"}},"required":["shared_to"],"title":"EmbeddedSharedDomains","type":"object"},"Domain":{"additionalProperties":false,"properties":{"description":{"description":"Domain description","type":"string"},"domain_group":{"additionalProperties":false,"description":"Associated domain group","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"status":{"enum":["root"],"type":"string"}},"type":"object"},"external_id":{"description":"External identifier","type":"string"},"id":{"description":"Domain ID","type":"integer"},"name":{"description":"Domain name","type":"string"},"parent_id":{"description":"Parent domain ID","nullable":true,"type":"integer"},"parents":{"description":"Ancestor domains","items":{"additionalProperties":false,"properties":{"external_id":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"}},"required":["id"],"type":"object"},"nullable":true,"type":"array"},"type":{"default":"domain","description":"Domain type","nullable":true,"type":"string"}},"required":["id"],"title":"Domain","type":"object"},"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"},"TdBgNotFoundResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgNotFoundResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```

## Share business concept with domains

> Replaces the domains with which the business concept is shared.\
> \
> Requires the \*\*'Share business concept with domain'\*\* permission on the concept's domain. When the concept is confidential, the caller must additionally hold \*\*'Manage confidential business concepts'\*\* on the same domain.\
> \
> \*\*Request body:\*\*\
> \- \`domain\_ids\` (required, array of integers) – Domains to share the concept with. Pass an empty array to remove all sharing.\
> \
> No additional check is performed on the target domains; sharing simply replaces the \`shared\_to\` list with the given domains.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-bg","version":"Truedat 8.11.0"},"paths":{"/api/business_concepts/{business_concept_id}/shared_domains":{"patch":{"description":"Replaces the domains with which the business concept is shared.\n\nRequires the **'Share business concept with domain'** permission on the concept's domain. When the concept is confidential, the caller must additionally hold **'Manage confidential business concepts'** on the same domain.\n\n**Request body:**\n- `domain_ids` (required, array of integers) – Domains to share the concept with. Pass an empty array to remove all sharing.\n\nNo additional check is performed on the target domains; sharing simply replaces the `shared_to` list with the given domains.\n","operationId":"TdBgWeb.SharedDomainController.update (2)","parameters":[{"description":"Business concept ID","in":"path","name":"business_concept_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedDomainUpdateRequest"}}},"description":"Shared domain payload","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedDomainUpdateResponse"}}},"description":"Business concept updated"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgForbiddenResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgNotFoundResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdBgInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Share business concept with domains","tags":["Business Concepts"]}}},"components":{"schemas":{"SharedDomainUpdateRequest":{"additionalProperties":false,"properties":{"domain_ids":{"description":"IDs of the domains with which the business concept should be shared. Sending an empty list removes the current domain sharing.","items":{"type":"integer"},"type":"array"}},"required":["domain_ids"],"title":"SharedDomainUpdateRequest","type":"object"},"SharedDomainUpdateResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/SharedBusinessConceptData"}},"required":["data"],"title":"SharedDomainUpdateResponse","type":"object"},"SharedBusinessConceptData":{"additionalProperties":false,"properties":{"_embedded":{"$ref":"#/components/schemas/EmbeddedSharedDomains"},"id":{"description":"Business concept ID","type":"integer"},"name":{"description":"Business concept name","nullable":true,"type":"string"},"updated_at":{"description":"Last update timestamp","format":"date-time","nullable":true,"type":"string"}},"required":["id","_embedded"],"title":"SharedBusinessConceptData","type":"object"},"EmbeddedSharedDomains":{"additionalProperties":false,"properties":{"shared_to":{"description":"List of domains the concept is shared with","items":{"$ref":"#/components/schemas/Domain"},"type":"array"}},"required":["shared_to"],"title":"EmbeddedSharedDomains","type":"object"},"Domain":{"additionalProperties":false,"properties":{"description":{"description":"Domain description","type":"string"},"domain_group":{"additionalProperties":false,"description":"Associated domain group","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"},"status":{"enum":["root"],"type":"string"}},"type":"object"},"external_id":{"description":"External identifier","type":"string"},"id":{"description":"Domain ID","type":"integer"},"name":{"description":"Domain name","type":"string"},"parent_id":{"description":"Parent domain ID","nullable":true,"type":"integer"},"parents":{"description":"Ancestor domains","items":{"additionalProperties":false,"properties":{"external_id":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"}},"required":["id"],"type":"object"},"nullable":true,"type":"array"},"type":{"default":"domain","description":"Domain type","nullable":true,"type":"string"}},"required":["id"],"title":"Domain","type":"object"},"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"},"TdBgNotFoundResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgNotFoundResponse","type":"object"},"TdBgInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdBgInternalServerErrorResponse","type":"object"}}}}
```
