Skip to content

Create records

POST /api/v1/entities/create: request fields and declared response contract.

POST/api/v1/entities/create

Authorization
Permissionparties.createRecord
Workspace scoperequired
Scope targetworkspace

Request body

Request body fields
FieldTypeRequiredNullableDefault
entityKindstringrequirednon-null—
valuesobjectoptionalnon-null{}
idempotencyKeystringoptionalnon-null—

Response

201

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.kindstringrequirednon-null—
data.idstringrequirednon-null—
data.fieldsobjectrequirednon-null—
data.createdAtstringrequirednon-null—

Declared failures

Declared failures
ACCESS_DENIED403 — not retryable
CORE_ERROR500 — not retryable
GOVERNANCE_DENIED403 — not retryable
ONTOLOGY_VALUE_INVALID422 — not retryable
QUOTA_DENIED429 — retryable
VALIDATION_ERROR400 — not retryable
VALIDATION_INPUT_ERROR400 — not retryable

Readback

Read the result back with:

  • entities.get

Request example

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

POST /api/v1/entities/create HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json

{
  "entityKind": "<entityKind>"
}