Get entity kinds
GET /api/v1/ontology/kinds/{partyKind}: request fields and declared response contract.
GET/api/v1/ontology/kinds/{partyKind}
| Permission | settings.read |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Parameters
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| partyKind | string | required | non-null | — |
Query parameters: none.
Response
200
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.id | string | required | non-null | — |
| data.workspaceId | string | required | non-null | — |
| data.companyId | string | required | non-null | — |
| data.partyKind | string | required | non-null | — |
| data.displayName | string | required | non-null | — |
| data.fields | array | required | non-null | — |
| data.implements | array | optional | non-null | — |
| data.cedarResourceType | string | required | non-null | — |
| data.parentKinds | array | required | non-null | — |
| data.version | integer | required | non-null | — |
| data.createdAt | string | required | non-null | — |
| data.updatedAt | string | required | non-null | — |
| data.provenance | unknown | optional | non-null | — |
Declared failures
| ONTOLOGY_GET_KIND_FAILED | 404 — not retryable |
|---|
Readback
This method returns the current state it read.
- ontology.getKind
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
GET /api/v1/ontology/kinds/{partyKind} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>