Skip to content

Declare entity kinds

POST /api/v1/ontology/kinds: request fields and declared response contract.

POST/api/v1/ontology/kinds

Authorization
Permissionparties.declareKind
Workspace scoperequired
Scope targetworkspace

Response

201

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.idstringrequirednon-null—
data.workspaceIdstringrequirednon-null—
data.companyIdstringrequirednon-null—
data.partyKindstringrequirednon-null—
data.displayNamestringrequirednon-null—
data.fieldsarrayrequirednon-null—
data.implementsarrayoptionalnon-null—
data.cedarResourceTypestringrequirednon-null—
data.parentKindsarrayrequirednon-null—
data.versionintegerrequirednon-null—
data.createdAtstringrequirednon-null—
data.updatedAtstringrequirednon-null—
data.provenanceunknownoptionalnon-null—

Declared failures

Declared failures
ONTOLOGY_DECLARE_KIND_FAILED400 — not retryable

Readback

Read the result back with:

  • ontology.getKind

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

POST /api/v1/ontology/kinds HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>