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

Domains

Get parentable domain IDs

get

Return IDs of domains that can be assigned as parents to the specified domain.

Path parameters
domain_idstringRequired

Domain ID

Responses
200

Parentable IDs

application/json
datainteger[]Required

List of domain IDs that can be parents

get/api/domains/{domain_id}/parentable_ids
GET /api/domains/{domain_id}/parentable_ids HTTP/1.1
Accept: */*

{
  "data": [
    1,
    2,
    3
  ]
}

Count business concepts in domain for user

get

Count the business concepts within a domain for the specified user.

Path parameters
domain_idstringRequired

Domain ID

Query parameters
user_namestringRequired

User name

Responses
200

Count response

application/json
get/api/domains/{domain_id}/business_concepts/{user_name}/count
GET /api/domains/{domain_id}/business_concepts/{user_name}/count?user_name=text HTTP/1.1
Accept: */*

{
  "data": {
    "counter": 5
  }
}

List domains

get

Returns all domains, optionally filtered by actions and permissions

Query parameters
actionsstringOptional

Comma-separated list of actions (e.g. show,create,update)

filterstringOptional

Filter mode (e.g. all)

Responses
200

Domains list

application/json
_actionsobjectOptional
get/api/domains
GET /api/domains HTTP/1.1
Accept: */*

{
  "_actions": {
    "create": {
      "href": "/api/domains",
      "input": {},
      "method": "POST"
    },
    "index": {
      "href": "/api/domains",
      "input": {},
      "method": "GET"
    }
  },
  "data": [
    {
      "description": "Finance domain",
      "external_id": "FIN-001",
      "id": 1,
      "name": "Finance",
      "parent_id": null,
      "type": "domain"
    }
  ],
  "hypermedia": {}
}

Create domain

post

Create a new domain with the provided domain payload.

Body
Responses
201

Domain created

application/json
_actionsobjectOptional
post/api/domains
POST /api/domains HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "domain": {
    "name": "Finance",
    "parent_id": null
  }
}
{
  "_actions": {
    "create": {
      "href": "/api/domains",
      "input": {},
      "method": "POST"
    },
    "index": {
      "href": "/api/domains",
      "input": {},
      "method": "GET"
    }
  },
  "data": {
    "description": "Finance domain",
    "domain_group": {
      "id": 10,
      "name": "Group A",
      "status": "root"
    },
    "external_id": "FIN-001",
    "id": 1,
    "name": "Finance",
    "parent_id": null,
    "parents": [],
    "type": "domain"
  },
  "hypermedia": {}
}

Get domain by id

get

Retrieve details for a specific domain by its ID.

Path parameters
idstringRequired

Domain ID

Responses
200

Domain

application/json
_actionsobjectOptional
get/api/domains/{id}
GET /api/domains/{id} HTTP/1.1
Accept: */*

{
  "_actions": {
    "create": {
      "href": "/api/domains",
      "input": {},
      "method": "POST"
    },
    "index": {
      "href": "/api/domains",
      "input": {},
      "method": "GET"
    }
  },
  "data": {
    "description": "Finance domain",
    "domain_group": {
      "id": 10,
      "name": "Group A",
      "status": "root"
    },
    "external_id": "FIN-001",
    "id": 1,
    "name": "Finance",
    "parent_id": null,
    "parents": [],
    "type": "domain"
  },
  "hypermedia": {}
}

Update domain

put

Update an existing domain using the provided payload.

Path parameters
idstringRequired

Domain ID

Body
Responses
200

Domain updated

application/json
_actionsobjectOptional
put/api/domains/{id}
PUT /api/domains/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "domain": {
    "name": "Finance Updated",
    "parent_id": 2
  }
}
{
  "_actions": {
    "create": {
      "href": "/api/domains",
      "input": {},
      "method": "POST"
    },
    "index": {
      "href": "/api/domains",
      "input": {},
      "method": "GET"
    }
  },
  "data": {
    "description": "Finance domain",
    "domain_group": {
      "id": 10,
      "name": "Group A",
      "status": "root"
    },
    "external_id": "FIN-001",
    "id": 1,
    "name": "Finance",
    "parent_id": null,
    "parents": [],
    "type": "domain"
  },
  "hypermedia": {}
}

Delete domain

delete

Delete a domain identified by the given ID.

Path parameters
idstringRequired

Domain ID

Responses
204

Domain deleted

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

No content

Update domain

patch

Update an existing domain using the provided payload.

Path parameters
idstringRequired

Domain ID

Body
Responses
200

Domain updated

application/json
_actionsobjectOptional
patch/api/domains/{id}
PATCH /api/domains/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "domain": {
    "name": "Finance Updated",
    "parent_id": 2
  }
}
{
  "_actions": {
    "create": {
      "href": "/api/domains",
      "input": {},
      "method": "POST"
    },
    "index": {
      "href": "/api/domains",
      "input": {},
      "method": "GET"
    }
  },
  "data": {
    "description": "Finance domain",
    "domain_group": {
      "id": 10,
      "name": "Group A",
      "status": "root"
    },
    "external_id": "FIN-001",
    "id": 1,
    "name": "Finance",
    "parent_id": null,
    "parents": [],
    "type": "domain"
  },
  "hypermedia": {}
}

Last updated