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

Business Concepts

Reindex all business concepts

get

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.

Responses
202

Reindex process accepted

No content

get/api/business_concepts/search/reindex_all
GET /api/business_concepts/search/reindex_all HTTP/1.1
Accept: */*

No content

Generate embeddings for all business concepts

post

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.

Responses
202

Reindex process accepted

No content

post/api/business_concepts/search/embeddings/_put
POST /api/business_concepts/search/embeddings/_put HTTP/1.1
Accept: */*

No content

Share business concept with domains

put

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.

Path parameters
business_concept_idintegerRequired

Business concept ID

Body
domain_idsinteger[]Required

IDs of the domains with which the business concept should be shared. Sending an empty list removes the current domain sharing.

Responses
200

Business concept updated

application/json
put/api/business_concepts/{business_concept_id}/shared_domains
PUT /api/business_concepts/{business_concept_id}/shared_domains HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "domain_ids": [
    1,
    2,
    3
  ]
}
{
  "data": {
    "_embedded": {
      "shared_to": [
        {
          "external_id": "MKT",
          "id": 1,
          "name": "Marketing",
          "type": "domain"
        }
      ]
    },
    "id": 123
  }
}

Share business concept with domains

patch

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.

Path parameters
business_concept_idintegerRequired

Business concept ID

Body
domain_idsinteger[]Required

IDs of the domains with which the business concept should be shared. Sending an empty list removes the current domain sharing.

Responses
200

Business concept updated

application/json
patch/api/business_concepts/{business_concept_id}/shared_domains
PATCH /api/business_concepts/{business_concept_id}/shared_domains HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "domain_ids": [
    1,
    2,
    3
  ]
}
{
  "data": {
    "_embedded": {
      "shared_to": [
        {
          "external_id": "MKT",
          "id": 1,
          "name": "Marketing",
          "type": "domain"
        }
      ]
    },
    "id": 123
  }
}

Last updated