Skip to content

Prepare a managed definition creation without creating a definition or provider resources.

POST
/api/workspace/admin/entity-semantic-operations/create
curl --request POST \
--url https://example.com/api/workspace/admin/entity-semantic-operations/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "OperationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Definition": { "Name": "example", "DisplayNameSingular": "example", "DisplayNamePlural": "example", "Description": "example", "IsReadOnly": true, "DisabledOperations": 0, "SemanticType": "example" }, "ProviderParameters": "example" }'
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Managed creation with caller-owned retry identity and provider-validated parameters.

object
OperationId

Stable idempotency identity reused for every retry of this exact request.

string format: uuid
Definition

Request payload to create an entity definition.

object
Name
required

Internal entity name.

string
DisplayNameSingular
required

User-facing singular name.

string
DisplayNamePlural
required

User-facing plural name.

string
Description

Optional entity description.

string
nullable
IsReadOnly

Whether runtime writes should be blocked for this entity.

boolean
DisabledOperations
integer format: int32
Allowed values: 0 1 2 4 8 16 32 64 128
SemanticType

Registered Data specialization. Generic preserves ordinary atomic creation.

string
nullable
ProviderParameters

Provider-owned input. Never include credentials or authorization grants.

OK

Media typeapplication/json
object
Data

Safe administration status. Provider plans, checkpoints and input payloads are never exposed here.

object
OperationId
string format: uuid
EntityDefinitionId
string
nullable
SemanticType
string
nullable
ProviderVersion
integer format: int32
Kind

Definition resource operation; never a replacement for Entity Instance mutations.

integer format: int32
Allowed values: 0 1 2
State

Completed means provider resources are ready, not that the definition is active/deleted. Only Finalized or Compensated releases the unfinished-operation reservation.

integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
Attempt
integer format: int64
DiagnosticCode
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Kind": 0,
"State": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Safe administration status. Provider plans, checkpoints and input payloads are never exposed here.

object
OperationId
string format: uuid
EntityDefinitionId
string
nullable
SemanticType
string
nullable
ProviderVersion
integer format: int32
Kind

Definition resource operation; never a replacement for Entity Instance mutations.

integer format: int32
Allowed values: 0 1 2
State

Completed means provider resources are ready, not that the definition is active/deleted. Only Finalized or Compensated releases the unfinished-operation reservation.

integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8
Attempt
integer format: int64
DiagnosticCode
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Kind": 0,
"State": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Conflict

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}