get_domain
curl --request GET \
--url https://ndi-api.nace.ai/v1/domains/{domain_id} \
--header 'X-API-Key: <api-key>'{
"class_count": 123,
"display_name": "<string>",
"domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ontology": {
"allow_other": false,
"edge_types": [
{
"description": "<string>",
"from_types": [
"<string>"
],
"name": "<string>",
"to_types": [
"<string>"
],
"property_hints": [
"<string>"
]
}
],
"node_types": [
{
"description": "<string>",
"name": "<string>",
"tier": 3,
"identifier_hints": [
"<string>"
],
"property_hints": [
"<string>"
]
}
]
},
"owner": "platform",
"selectable": true,
"slug": "<string>",
"status": "draft",
"taxonomy": {
"allow_other": true,
"classes": [
{
"description": "<string>",
"document_type": "<string>",
"group": "<string>",
"subgroup": "<string>",
"aliases": [
"<string>"
]
}
]
},
"version": 123,
"parent_slug": "<string>",
"published_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}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.
GET
/
v1
/
domains
/
{domain_id}
get_domain
curl --request GET \
--url https://ndi-api.nace.ai/v1/domains/{domain_id} \
--header 'X-API-Key: <api-key>'{
"class_count": 123,
"display_name": "<string>",
"domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ontology": {
"allow_other": false,
"edge_types": [
{
"description": "<string>",
"from_types": [
"<string>"
],
"name": "<string>",
"to_types": [
"<string>"
],
"property_hints": [
"<string>"
]
}
],
"node_types": [
{
"description": "<string>",
"name": "<string>",
"tier": 3,
"identifier_hints": [
"<string>"
],
"property_hints": [
"<string>"
]
}
]
},
"owner": "platform",
"selectable": true,
"slug": "<string>",
"status": "draft",
"taxonomy": {
"allow_other": true,
"classes": [
{
"description": "<string>",
"document_type": "<string>",
"group": "<string>",
"subgroup": "<string>",
"aliases": [
"<string>"
]
}
]
},
"version": 123,
"parent_slug": "<string>",
"published_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}Authorizations
Path Parameters
Domain version identifier.
Response
Successful Response
A domain with inheritance already resolved.
A caller reading a domain wants the vocabulary that will actually be applied, not a delta they have to merge themselves.
Effective, with the parent's inherited entries merged in.
Show child attributes
Show child attributes
Available options:
platform, tenant True once published; a workspace may only pin a published version.
Available options:
draft, published The classification vocabulary.
Show child attributes
Show child attributes
Inheritance lineage for platform domains that extend a base vocabulary.