Create a field inside one entity definition table.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definition-tables/example/fields"), Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"FieldType\": 0, \"VisibleWhen\": \"example\", \"RequiredWhen\": \"example\", \"EditableWhen\": \"example\", \"DecimalPrecision\": 1, \"DecimalScale\": 1, \"StringMaxLength\": 1, \"AllowMultiple\": true, \"ReferenceToEntityDefinitionId\": \"example\", \"PairedReferenceFieldId\": \"example\", \"AllowSort\": true, \"ReferenceDeleteBehavior\": 0, \"Options\": [ { \"Key\": \"example\", \"Value\": \"example\" } ], \"AddressCoordinatesRequired\": true, \"IsReadOnly\": true, \"VisibleWhenOperationMode\": 0, \"RequiredWhenOperationMode\": 0, \"EditableWhenOperationMode\": 0, \"BaseCurrencyCode\": \"example\", \"ReferenceArchiveBehavior\": 0, \"ReferenceAuditRollupBehavior\": 0, \"SemanticRole\": 0, \"SemanticRoleScopeFieldId\": \"example\", \"ClassifierCatalogDefinitionId\": \"example\", \"DefaultValue\": { \"Kind\": 0, \"Value\": {} } }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/entity-definition-tables/example/fields';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"Key":"example","DisplayName":"example","FieldType":0,"VisibleWhen":"example","RequiredWhen":"example","EditableWhen":"example","DecimalPrecision":1,"DecimalScale":1,"StringMaxLength":1,"AllowMultiple":true,"ReferenceToEntityDefinitionId":"example","PairedReferenceFieldId":"example","AllowSort":true,"ReferenceDeleteBehavior":0,"Options":[{"Key":"example","Value":"example"}],"AddressCoordinatesRequired":true,"IsReadOnly":true,"VisibleWhenOperationMode":0,"RequiredWhenOperationMode":0,"EditableWhenOperationMode":0,"BaseCurrencyCode":"example","ReferenceArchiveBehavior":0,"ReferenceAuditRollupBehavior":0,"SemanticRole":0,"SemanticRoleScopeFieldId":"example","ClassifierCatalogDefinitionId":"example","DefaultValue":{"Kind":0,"Value":{}}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/admin/entity-definition-tables/example/fields \ --header 'Content-Type: application/json' \ --data '{ "Key": "example", "DisplayName": "example", "FieldType": 0, "VisibleWhen": "example", "RequiredWhen": "example", "EditableWhen": "example", "DecimalPrecision": 1, "DecimalScale": 1, "StringMaxLength": 1, "AllowMultiple": true, "ReferenceToEntityDefinitionId": "example", "PairedReferenceFieldId": "example", "AllowSort": true, "ReferenceDeleteBehavior": 0, "Options": [ { "Key": "example", "Value": "example" } ], "AddressCoordinatesRequired": true, "IsReadOnly": true, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "BaseCurrencyCode": "example", "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "SemanticRoleScopeFieldId": "example", "ClassifierCatalogDefinitionId": "example", "DefaultValue": { "Kind": 0, "Value": {} } }'Field type semantics and per-type settings:
fields and schema.
Behavior conditions (VisibleWhen, RequiredWhen, EditableWhen) use the
expression language.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Request payload to create an entity field.
object
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Editability condition expression.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Select options when applicable.
Option payload for select fields.
object
Option key.
Option display value.
Whether address values must carry latitude and longitude.
Whether runtime writes should skip this field.
Base currency code for Money fields.
Field identifier used as semantic scope, when the selected role requires one.
Classifier Catalog Definition identifier for Classifier fields.
Default value configuration for an entity field.
object
Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.
object
Request payload to create an entity field.
object
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Editability condition expression.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Select options when applicable.
Option payload for select fields.
object
Option key.
Option display value.
Whether address values must carry latitude and longitude.
Whether runtime writes should skip this field.
Base currency code for Money fields.
Field identifier used as semantic scope, when the selected role requires one.
Classifier Catalog Definition identifier for Classifier fields.
Default value configuration for an entity field.
object
Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.
object
Request payload to create an entity field.
object
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Editability condition expression.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Select options when applicable.
Option payload for select fields.
object
Option key.
Option display value.
Whether address values must carry latitude and longitude.
Whether runtime writes should skip this field.
Base currency code for Money fields.
Field identifier used as semantic scope, when the selected role requires one.
Classifier Catalog Definition identifier for Classifier fields.
Default value configuration for an entity field.
object
Constant JSON value. A scalar Reference uses one entity-instance id string. Must be null for dynamic defaults.
object
Responses
Section titled “Responses”OK
object
Metadata for one entity field definition.
object
Field identifier.
Entity definition identifier.
Entity definition table identifier.
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Package-owned business requiredness condition expression.
Editability condition expression.
Whether runtime writes should skip this field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Sort order inside the owning table.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Child table metadata identifier for table fields.
Whether the field is soft-deleted.
Deletion timestamp.
Concurrency token.
Whether address values must carry latitude and longitude.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Owner-scoped metadata attached to this field.
Owner-scoped metadata attached to one entity field definition.
object
Metadata row identifier.
Owning field identifier.
Module that owns this metadata key.
Metadata key inside the owner module.
Metadata value as JSON.
object
Concurrency token.
Base currency code for Money fields.
Stored calculated-field expression.
Field identifier used as semantic scope, when the selected role requires one.
Bound Classifier Catalog Definition identifier.
Stable key of the bound Classifier Catalog Definition.
Display name of the bound Classifier Catalog Definition.
Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.
object
Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.
object
Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.
object
object
object
object
Example
{ "Data": { "FieldType": 0, "ReferenceDeleteBehavior": 0, "SchemaSource": 0, "SystemRole": 0, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "CalculationKind": 0, "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "DefaultValue": { "Kind": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Metadata for one entity field definition.
object
Field identifier.
Entity definition identifier.
Entity definition table identifier.
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Package-owned business requiredness condition expression.
Editability condition expression.
Whether runtime writes should skip this field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Sort order inside the owning table.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Child table metadata identifier for table fields.
Whether the field is soft-deleted.
Deletion timestamp.
Concurrency token.
Whether address values must carry latitude and longitude.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Owner-scoped metadata attached to this field.
Owner-scoped metadata attached to one entity field definition.
object
Metadata row identifier.
Owning field identifier.
Module that owns this metadata key.
Metadata key inside the owner module.
Metadata value as JSON.
object
Concurrency token.
Base currency code for Money fields.
Stored calculated-field expression.
Field identifier used as semantic scope, when the selected role requires one.
Bound Classifier Catalog Definition identifier.
Stable key of the bound Classifier Catalog Definition.
Display name of the bound Classifier Catalog Definition.
Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.
object
Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.
object
Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.
object
object
object
object
Example
{ "Data": { "FieldType": 0, "ReferenceDeleteBehavior": 0, "SchemaSource": 0, "SystemRole": 0, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "CalculationKind": 0, "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "DefaultValue": { "Kind": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Metadata for one entity field definition.
object
Field identifier.
Entity definition identifier.
Entity definition table identifier.
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Package-owned business requiredness condition expression.
Editability condition expression.
Whether runtime writes should skip this field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Sort order inside the owning table.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Child table metadata identifier for table fields.
Whether the field is soft-deleted.
Deletion timestamp.
Concurrency token.
Whether address values must carry latitude and longitude.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Owner-scoped metadata attached to this field.
Owner-scoped metadata attached to one entity field definition.
object
Metadata row identifier.
Owning field identifier.
Module that owns this metadata key.
Metadata key inside the owner module.
Metadata value as JSON.
object
Concurrency token.
Base currency code for Money fields.
Stored calculated-field expression.
Field identifier used as semantic scope, when the selected role requires one.
Bound Classifier Catalog Definition identifier.
Stable key of the bound Classifier Catalog Definition.
Display name of the bound Classifier Catalog Definition.
Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.
object
Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.
object
Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.
object
object
object
object
Example
{ "Data": { "FieldType": 0, "ReferenceDeleteBehavior": 0, "SchemaSource": 0, "SystemRole": 0, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "CalculationKind": 0, "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "DefaultValue": { "Kind": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Metadata for one entity field definition.
object
Field identifier.
Entity definition identifier.
Entity definition table identifier.
Field key.
Field display name.
Visibility condition expression.
Requiredness condition expression.
Package-owned business requiredness condition expression.
Editability condition expression.
Whether runtime writes should skip this field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Whether multiple values are allowed.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse reference fields.
Whether root-list sorting by linked display value is allowed.
Sort order inside the owning table.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Child table metadata identifier for table fields.
Whether the field is soft-deleted.
Deletion timestamp.
Concurrency token.
Whether address values must carry latitude and longitude.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Owner-scoped metadata attached to this field.
Owner-scoped metadata attached to one entity field definition.
object
Metadata row identifier.
Owning field identifier.
Module that owns this metadata key.
Metadata key inside the owner module.
Metadata value as JSON.
object
Concurrency token.
Base currency code for Money fields.
Stored calculated-field expression.
Field identifier used as semantic scope, when the selected role requires one.
Bound Classifier Catalog Definition identifier.
Stable key of the bound Classifier Catalog Definition.
Display name of the bound Classifier Catalog Definition.
Configured default applied to an absent primary field on create or an absent child field in a new table row. It does not change existing rows.
object
Canonical constant JSON value. A scalar Reference contains only the target entity-instance id string. Null for dynamic defaults.
object
Whether the field’s system-owned structural shape is protected while administrator-owned metadata remains editable.
object
object
object
object
Example
{ "Data": { "FieldType": 0, "ReferenceDeleteBehavior": 0, "SchemaSource": 0, "SystemRole": 0, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "CalculationKind": 0, "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0, "DefaultValue": { "Kind": 0 } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}