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

Business Concept Versions

Send business concept version for approval

post

Submit the specified business concept version for review and approval.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Responses
200

Business concept version submitted

application/json
post/api/business_concept_versions/{business_concept_version_id}/submit
POST /api/business_concept_versions/{business_concept_version_id}/submit HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Deprecate business concept version

post

Deprecate the specified business concept version so it is no longer current.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Responses
200

Business concept version deprecated

application/json
post/api/business_concept_versions/{business_concept_version_id}/deprecate
POST /api/business_concept_versions/{business_concept_version_id}/deprecate HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

List available actions for business concept versions

get

Return hypermedia actions available for business concept versions based on the current user permissions.

Responses
200

Actions

application/json
dataobject[] · nullableOptional
get/api/business_concept_versions/actions
GET /api/business_concept_versions/actions HTTP/1.1
Accept: */*

{
  "_actions": {
    "autoPublish": {
      "href": "/api/business_concept_versions/upload",
      "input": {},
      "method": "POST"
    },
    "create": {
      "href": "/api/business_concept_versions",
      "input": {},
      "method": "POST"
    },
    "downloadLinks": {
      "href": "/api/business_concept_versions/links/download",
      "input": {},
      "method": "POST"
    },
    "upload": {
      "href": "/api/business_concept_versions/upload",
      "input": {},
      "method": "POST"
    }
  },
  "data": []
}

Restore deprecated business concept version

post

Restore a deprecated business concept version back to a publishable state.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Responses
200

Business concept version restored

application/json
post/api/business_concept_versions/{business_concept_version_id}/restore
POST /api/business_concept_versions/{business_concept_version_id}/restore HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Upload business concepts file

post

Upload an Excel file to create or update business concept versions in bulk.

Body

Multipart request for uploading business concepts file

auto_publishstring · enumOptional

Whether to auto-publish after upload

Default: falsePossible values:
business_conceptsstring · binaryRequired

Excel file (.xlsx) with business concepts

langstringOptional

Language code for the content

Default: en
Responses
202

Business concepts upload started

application/json
Other propertiesanyOptional
post/api/business_concept_versions/upload
POST /api/business_concept_versions/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 78

{
  "auto_publish": "true",
  "business_concepts": "YmluYXJ5IGNvbnRlbnQ=",
  "lang": "en"
}
{
  "file_hash": "abc123",
  "status": "STARTED",
  "task_reference": "task-123"
}

Download business concepts as CSV

post

Download a CSV export of business concept version results matching the current filters.

Query parameters
querystringOptional

Full‑text search across business concept fields

sortstringOptional

Sort field(s), e.g. name.raw, -last_change_at

scrollstringOptional

Scroll timeout (e.g. 2m)

scroll_idstringOptional

Scroll ID to continue a previous scroll

only_linkablebooleanOptional

If true, returns only concepts that can be linked

langstringOptional

Language code (e.g., 'en', 'es')

concept_url_schemastringOptional

URL schema for concept links

Responses
200

CSV file downloaded

text/csv
string · binaryOptional
post/api/business_concept_versions/csv
POST /api/business_concept_versions/csv HTTP/1.1
Accept: */*

binary

Undo business concept version rejection

post

Restore a rejected business concept version to draft status.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Responses
200

Business concept version restored to draft

application/json
post/api/business_concept_versions/{business_concept_version_id}/redraft
POST /api/business_concept_versions/{business_concept_version_id}/redraft HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Set business concept confidentiality

post

Update the confidentiality setting for a business concept version.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Body
confidentialbooleanRequired

Confidential flag

Responses
200

Business concept confidentiality updated

application/json
post/api/business_concept_versions/{business_concept_version_id}/set_confidential
POST /api/business_concept_versions/{business_concept_version_id}/set_confidential HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "confidential": true
}
{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Show business concept version

get

Retrieve the details of a specific business concept version.

Path parameters
business_concept_idintegerRequired

Business concept ID

idintegerRequired

Business concept version ID

Responses
200

Business concept version

application/json
get/api/business_concepts/{business_concept_id}/versions/{id}
GET /api/business_concepts/{business_concept_id}/versions/{id} HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Bulk update business concepts

post

Update multiple business concept versions in bulk based on the provided search criteria and update payload.

Body
Responses
200

Business concepts updated

application/json
post/api/business_concept_versions/bulk_update
POST /api/business_concept_versions/bulk_update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "search_params": {
    "query": "domain_id:12"
  },
  "update_attributes": {
    "status": "deprecated"
  }
}
{
  "data": {
    "message": [
      1236
    ]
  }
}

Update business concept version

put

Update an existing business concept version with new content or metadata.

Path parameters
idintegerRequired

Business concept version ID

Body
Responses
200

Business concept version updated

application/json
put/api/business_concept_versions/{id}
PUT /api/business_concept_versions/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "business_concept_version": {
    "content": {
      "definition": "Updated definition"
    },
    "name": "Updated Customer Email"
  }
}
{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Delete business concept version

delete

Delete the specified business concept version.

Path parameters
idintegerRequired

Business concept version ID

Responses
204

Business concept version deleted

No content
delete/api/business_concept_versions/{id}
DELETE /api/business_concept_versions/{id} HTTP/1.1
Accept: */*

No content

Publish business concept version

post

Publish the specified business concept version once it is approved.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Responses
200

Business concept version published

application/json
post/api/business_concept_versions/{business_concept_version_id}/publish
POST /api/business_concept_versions/{business_concept_version_id}/publish HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

List business concept versions by filters or concept id

get

Retrieve a paginated list of business concept versions filtered by query parameters or business concept ID.

Path parameters
business_concept_idintegerRequired

Business concept id

Query parameters
pageintegerOptional

Número de página (0-indexed)

Default: 0
sizeintegerOptional

Cantidad de resultados por página

Default: 50
include_linksbooleanOptional

Si es true, incluye relaciones de enlaces en la respuesta

Default: false
scrollstringOptional

Tiempo de expiración del scroll (ej. 1m)

scroll_idstringOptional

ID de scroll para continuar paginando

sortstringOptional

Campos de ordenamiento (ej. name.raw, -last_change_at)

querystringOptional

Búsqueda de texto completo

Responses
200

Search results

application/json
_actionsobject · nullableOptional
scroll_idstring · nullableOptional
get/api/business_concepts/{business_concept_id}/versions
GET /api/business_concepts/{business_concept_id}/versions HTTP/1.1
Accept: */*

{
  "_actions": {
    "downloadPublishedConcepts": {
      "href": "/api/business_concept_versions/download",
      "method": "POST"
    }
  },
  "data": [
    {
      "business_concept_id": 10,
      "domain_id": 5,
      "domain_parents": [
        {
          "id": 5,
          "name": "Marketing"
        }
      ],
      "id": 1,
      "name": "Customer Email",
      "status": "published"
    }
  ],
  "scroll_id": null
}

Search business concept versions

post

Execute a search for business concept versions using advanced filters provided in the request body.

Body
include_linksbooleanOptionalDefault: false
only_linkablebooleanOptional

If true, returns only concepts that can be linked (user must have manage_business_concept_links permission)

Default: false
pageintegerOptionalDefault: 0
querystring · nullableOptional
scrollstring · nullableOptional
scroll_idstring · nullableOptional
sizeintegerOptionalDefault: 50
Responses
200

Search results

application/json
_actionsobject · nullableOptional
scroll_idstring · nullableOptional
post/api/business_concept_versions/search
POST /api/business_concept_versions/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "filters": {
    "domain_id": [
      123
    ]
  },
  "include_links": true,
  "must": {
    "status": [
      "published"
    ]
  },
  "only_linkable": true,
  "page": 0,
  "query": "customer",
  "size": 50,
  "sort": {
    "name.raw": "asc"
  }
}
{
  "_actions": {
    "downloadPublishedConcepts": {
      "href": "/api/business_concept_versions/download",
      "method": "POST"
    }
  },
  "data": [
    {
      "business_concept_id": 10,
      "domain_id": 5,
      "domain_parents": [
        {
          "id": 5,
          "name": "Marketing"
        }
      ],
      "id": 1,
      "name": "Customer Email",
      "status": "published"
    }
  ],
  "scroll_id": null
}

Reject business concept version

post

Reject the specified business concept version with a given reason.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Body
reject_reasonstringOptional

Reason for rejection

Responses
200

Business concept version rejected

application/json
post/api/business_concept_versions/{business_concept_version_id}/reject
POST /api/business_concept_versions/{business_concept_version_id}/reject HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "reject_reason": "Definition is incomplete"
}
{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Create new version from published business concept version

post

Create a successor version from an existing published business concept version.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Responses
201

Business concept version created

application/json
post/api/business_concept_versions/{business_concept_version_id}/version
POST /api/business_concept_versions/{business_concept_version_id}/version HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

List business concept versions by filters or concept id

get

Retrieve a paginated list of business concept versions filtered by query parameters or business concept ID.

Path parameters
business_concept_idintegerRequired

Business concept id

Query parameters
pageintegerOptional

Número de página (0-indexed)

Default: 0
sizeintegerOptional

Cantidad de resultados por página

Default: 50
include_linksbooleanOptional

Si es true, incluye relaciones de enlaces en la respuesta

Default: false
scrollstringOptional

Tiempo de expiración del scroll (ej. 1m)

scroll_idstringOptional

ID de scroll para continuar paginando

sortstringOptional

Campos de ordenamiento (ej. name.raw, -last_change_at)

querystringOptional

Búsqueda de texto completo

Responses
200

Search results

application/json
_actionsobject · nullableOptional
scroll_idstring · nullableOptional
get/api/business_concept_versions
GET /api/business_concept_versions HTTP/1.1
Accept: */*

{
  "_actions": {
    "downloadPublishedConcepts": {
      "href": "/api/business_concept_versions/download",
      "method": "POST"
    }
  },
  "data": [
    {
      "business_concept_id": 10,
      "domain_id": 5,
      "domain_parents": [
        {
          "id": 5,
          "name": "Marketing"
        }
      ],
      "id": 1,
      "name": "Customer Email",
      "status": "published"
    }
  ],
  "scroll_id": null
}

Create business concept version

post

Create a new business concept version for the specified concept template and domain.

Body
Responses
201

Business concept version created

application/json
post/api/business_concept_versions
POST /api/business_concept_versions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "business_concept_version": {
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "domain_id": 12,
    "name": "Customer Email",
    "type": "glossary"
  }
}
{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Download business concepts as XLSX

post

Download a spreadsheet containing business concept version results returned by the current search criteria.

Query parameters
querystringOptional

Full‑text search across business concept fields

sortstringOptional

Sort field(s), e.g. name.raw, -last_change_at

scrollstringOptional

Scroll timeout (e.g. 2m)

scroll_idstringOptional

Scroll ID to continue a previous scroll

only_linkablebooleanOptional

If true, returns only concepts that can be linked

langstringOptional

Language code (e.g., 'en', 'es')

concept_url_schemastringOptional

URL schema for concept links

Responses
200

XLSX file downloaded

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string · binaryOptional
post/api/business_concept_versions/xlsx
POST /api/business_concept_versions/xlsx HTTP/1.1
Accept: */*

binary

Update business concept domain

post

Change the domain of a business concept version.

Path parameters
business_concept_version_idintegerRequired

Business concept version ID

Body
domain_idintegerRequired

New domain ID

Responses
200

Business concept domain updated

application/json
post/api/business_concept_versions/{business_concept_version_id}/domain
POST /api/business_concept_versions/{business_concept_version_id}/domain HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "domain_id": 15
}
{
  "data": {
    "_embedded": {
      "links": [],
      "shared_to": [
        {
          "id": 5,
          "name": "Finance"
        }
      ]
    },
    "actions": {
      "share": {
        "href": "/api/business_concepts/100/shared_domains",
        "input": {},
        "method": "PATCH"
      },
      "view_quality_rule": {
        "method": "GET"
      }
    },
    "business_concept_id": 100,
    "completeness": 80,
    "concept_count": 0,
    "confidential": false,
    "content": {
      "definition": "Customer email address"
    },
    "current": true,
    "domain": {
      "id": 12,
      "name": "Marketing"
    },
    "domain_parents": [
      {
        "id": 1,
        "name": "Business"
      }
    ],
    "id": 1,
    "last_change_at": "2026-06-02T10:00:00Z",
    "last_change_by": 10,
    "link_count": 5,
    "name": "Customer Email",
    "rule_count": 3,
    "status": "published",
    "type": "glossary",
    "version": 2
  }
}

Last updated