domains

get_domain

Read one domain version, with inheritance already resolved. Cost class: cacheable.

A caller reading a domain wants the vocabulary that will actually be applied, not a delta they have to merge themselves.

Args: session: Database session. caller: The authenticated tenant. domain_id: The domain version to read.

Returns: The domain and its effective taxonomy.

Raises: PlatformError: domain_not_found when it does not exist or belongs to another tenant.

get/v1/domains/{domain_id}

Request

Path parameters

domain_idstring uuid required

Domain version identifier.

Response

Successful Response

domain_idstring uuid required
slugstring required
display_namestring required
owner'platform' | 'tenant' required
versioninteger required
status'draft' | 'published' required
parent_slugstring nullable

Inheritance lineage for platform domains that extend a base vocabulary.

class_countinteger required
selectableboolean required

True once published; a workspace may only pin a published version.

published_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.