Return one entity definition.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/entity-definitions/example"),};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/entity-definitions/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/entity-definitions/exampleAuthorizations
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.
Responses
Section titled “Responses”OK
object
Full entity definition detail.
object
Entity definition identifier.
Internal entity name.
User-facing singular name.
User-facing plural name.
Optional entity description.
Whether comments are enabled.
Whether attachments are enabled.
Whether tags are enabled.
Whether full-text search is enabled for the definition.
Whether audit trail is enabled.
Retention days when mode is days-based.
Configured number prefix.
Whether runtime writes are blocked for this entity.
Whether the definition is frozen pending deletion.
Timestamp when deferred deletion was requested.
Scheduled purge timestamp.
Definition tables.
Metadata for one physical table used by an entity definition.
object
Table metadata identifier.
Entity definition identifier.
Logical table name.
Database schema name.
Physical table name.
Whether this is the primary entity table.
Owner field identifier for child tables.
Fields that belong to the table.
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.
Whether the field is explicitly excluded from full-text search.
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.
Explicit field access overrides.
Explicit field access override for one subject.
object
Rule identifier.
Field identifier.
Resolved permission subject metadata.
object
Subject identifier.
Resolved display name.
Optional secondary description.
Ascending evaluation order.
Concurrency token.
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.
Whether the table metadata is soft-deleted.
Deletion timestamp.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Configured relation definitions.
Entity relation definition metadata.
object
Relation definition identifier.
Owning entity definition identifier.
Internal key.
User-facing display name.
Whether runtime assignments will be required.
Eligible responsibility groups for assignments on this relation.
Summary projection for one responsibility group.
object
Group identifier.
Optional code-facing identifier.
Display name.
Optional description.
Assigned member count.
Concurrency token.
Ascending sort order.
Whether the relation definition is soft-deleted.
Deletion timestamp.
Concurrency token.
Subject-based permissions for the entity.
Entity permission entry for one subject.
object
Permission identifier.
Entity definition identifier.
Resolved permission subject metadata.
object
Subject identifier.
Resolved display name.
Optional secondary description.
Optional target relation definition for assignment-update permissions.
Ascending evaluation order.
Concurrency token.
Configured unique constraints.
Unique constraint configured for one entity definition table.
object
Constraint identifier.
Entity definition identifier.
Owning table identifier.
Ordered participating fields.
Field entry participating in an entity unique constraint.
object
Field identifier.
Owning table identifier.
Field key.
User-facing field name.
Concurrency token.
Configured non-unique indexes.
Non-unique index configured for one entity definition table.
object
Index identifier.
Entity definition identifier.
Owning table identifier.
Ordered participating fields.
Field participating in one definition index.
object
Field identifier.
Owning table identifier.
Internal field key.
User-facing field name.
Concurrency token.
Configured entity statements.
Administrative entity statement definition.
object
Statement identifier.
Owning entity definition identifier.
Stable technical statement key.
User-facing statement label.
Stored SQL-like statement expression.
Whether runtime payloads expose this statement as a predicate flag.
Statement ordering inside the entity definition.
Whether the statement is soft-deleted.
Soft-delete timestamp when deleted.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Configured entity validation rules.
Administrative entity validation rule definition.
object
Validation rule identifier.
Owning entity definition identifier.
Stable technical validation rule key.
User-facing validation rule label.
Validation expression.
User-facing validation failure message.
Optional localized validation failure message templates keyed by locale.
object
Whether this validation rule is active.
Validation rule ordering inside the entity definition.
Whether the validation rule is soft-deleted.
Soft-delete timestamp when deleted.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Configured entity presentation rules.
Metadata for one entity presentation rule.
object
Presentation rule identifier.
Owning entity definition identifier.
Stored render template.
Stored rule condition expression.
Stable ordering inside one presentation slot.
Whether the rule is soft-deleted.
Soft-delete timestamp when deleted.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Owning module key when UsageType is Moltaro.Enums.EntityUsageTypeEnum.Part.
Owning aggregate type when UsageType is Moltaro.Enums.EntityUsageTypeEnum.Part.
Owning aggregate identifier when UsageType is Moltaro.Enums.EntityUsageTypeEnum.Part.
Read model for contained parent access inheritance policy.
object
Policy id.
Child entity definition id.
Parent entity definition id.
Parent entity display name.
Parent reference field id on the child entity.
Parent reference field key.
Parent reference field display name.
Whether the policy is active.
Maximum propagation depth stored for future reconciliation.
When the child is an Association, whether inherited access continues to the opposite endpoint.
Opposite endpoint entity definition id when transit is available.
Opposite endpoint display name when transit is available.
Relation mappings.
Read model for one inherited access relation map.
object
Relation map id.
Parent relation definition id.
Parent relation definition key.
Parent relation definition display name.
Child relation definition id.
Child relation definition key.
Child relation definition display name.
Whether the map is active.
Display order.
Concurrency token.
Concurrency token.
Association endpoint and generated inverse binding metadata.
object
Binding identifier.
Association entity definition identifier.
Left endpoint target entity definition identifier.
Right endpoint target entity definition identifier.
Left required reference field on the association entity.
Right required reference field on the association entity.
Generated inverse field on the left endpoint entity.
Generated inverse field on the right endpoint entity.
Projection-entity configuration for one entity definition.
object
Projection-entity source member configuration.
object
Projection-entity field mapping rule.
object
Entity-level default runtime sort sequence.
Entity-level default runtime sort item.
object
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Default sort order.
Display-only computed fields available to table and card surfaces.
Display-only computed field metadata.
object
One ordered rule for a display-only computed field.
object
ID-only object-context facts materialized onto entity-instance read models.
Object-context fact configuration for one entity definition.
object
object
object
object
object
object
Example
{ "Data": { "AuditTrailRetentionMode": 0, "AccessModel": 0, "DisabledOperations": 0, "Tables": [ { "Fields": [ { "FieldType": 0, "ReferenceDeleteBehavior": 0, "AccessRules": [ { "Subject": { "SubjectType": 0 }, "AccessLevel": 0 } ], "SchemaSource": 0, "SystemRole": 0, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "CalculationKind": 0, "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0 } ], "SchemaSource": 0 } ], "RelationDefinitions": [ { "Semantic": 0, "Cardinality": 0, "SubjectMode": 0, "ResponsibilityGroups": [ { "Type": 0 } ] } ], "Permissions": [ { "Scope": 0, "Action": 0, "Subject": { "SubjectType": 0 } } ], "Statements": [ { "SchemaSource": 0 } ], "ValidationRules": [ { "SchemaSource": 0 } ], "PresentationRules": [ { "Target": 0, "SchemaSource": 0 } ], "SchemaSource": 0, "UsageType": 0, "Projection": { "ProjectionKind": 0, "OpenBehavior": 0, "Mappings": [ { "TargetKind": 0, "TransformKind": 0 } ] }, "DefaultSort": [ { "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 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
Full entity definition detail.
object
Entity definition identifier.
Internal entity name.
User-facing singular name.
User-facing plural name.
Optional entity description.
Whether comments are enabled.
Whether attachments are enabled.
Whether tags are enabled.
Whether full-text search is enabled for the definition.
Whether audit trail is enabled.
Retention days when mode is days-based.
Configured number prefix.
Whether runtime writes are blocked for this entity.
Whether the definition is frozen pending deletion.
Timestamp when deferred deletion was requested.
Scheduled purge timestamp.
Definition tables.
Metadata for one physical table used by an entity definition.
object
Table metadata identifier.
Entity definition identifier.
Logical table name.
Database schema name.
Physical table name.
Whether this is the primary entity table.
Owner field identifier for child tables.
Fields that belong to the table.
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.
Whether the field is explicitly excluded from full-text search.
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.
Explicit field access overrides.
Explicit field access override for one subject.
object
Rule identifier.
Field identifier.
Resolved permission subject metadata.
object
Subject identifier.
Resolved display name.
Optional secondary description.
Ascending evaluation order.
Concurrency token.
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.
Whether the table metadata is soft-deleted.
Deletion timestamp.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Configured relation definitions.
Entity relation definition metadata.
object
Relation definition identifier.
Owning entity definition identifier.
Internal key.
User-facing display name.
Whether runtime assignments will be required.
Eligible responsibility groups for assignments on this relation.
Summary projection for one responsibility group.
object
Group identifier.
Optional code-facing identifier.
Display name.
Optional description.
Assigned member count.
Concurrency token.
Ascending sort order.
Whether the relation definition is soft-deleted.
Deletion timestamp.
Concurrency token.
Subject-based permissions for the entity.
Entity permission entry for one subject.
object
Permission identifier.
Entity definition identifier.
Resolved permission subject metadata.
object
Subject identifier.
Resolved display name.
Optional secondary description.
Optional target relation definition for assignment-update permissions.
Ascending evaluation order.
Concurrency token.
Configured unique constraints.
Unique constraint configured for one entity definition table.
object
Constraint identifier.
Entity definition identifier.
Owning table identifier.
Ordered participating fields.
Field entry participating in an entity unique constraint.
object
Field identifier.
Owning table identifier.
Field key.
User-facing field name.
Concurrency token.
Configured non-unique indexes.
Non-unique index configured for one entity definition table.
object
Index identifier.
Entity definition identifier.
Owning table identifier.
Ordered participating fields.
Field participating in one definition index.
object
Field identifier.
Owning table identifier.
Internal field key.
User-facing field name.
Concurrency token.
Configured entity statements.
Administrative entity statement definition.
object
Statement identifier.
Owning entity definition identifier.
Stable technical statement key.
User-facing statement label.
Stored SQL-like statement expression.
Whether runtime payloads expose this statement as a predicate flag.
Statement ordering inside the entity definition.
Whether the statement is soft-deleted.
Soft-delete timestamp when deleted.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Configured entity validation rules.
Administrative entity validation rule definition.
object
Validation rule identifier.
Owning entity definition identifier.
Stable technical validation rule key.
User-facing validation rule label.
Validation expression.
User-facing validation failure message.
Optional localized validation failure message templates keyed by locale.
object
Whether this validation rule is active.
Validation rule ordering inside the entity definition.
Whether the validation rule is soft-deleted.
Soft-delete timestamp when deleted.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Configured entity presentation rules.
Metadata for one entity presentation rule.
object
Presentation rule identifier.
Owning entity definition identifier.
Stored render template.
Stored rule condition expression.
Stable ordering inside one presentation slot.
Whether the rule is soft-deleted.
Soft-delete timestamp when deleted.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Concurrency token.
Stable NET package root id when package-owned.
NET package artifact id when package-owned.
Stable Moltaro id when package-owned.
Owning module key when UsageType is Moltaro.Enums.EntityUsageTypeEnum.Part.
Owning aggregate type when UsageType is Moltaro.Enums.EntityUsageTypeEnum.Part.
Owning aggregate identifier when UsageType is Moltaro.Enums.EntityUsageTypeEnum.Part.
Read model for contained parent access inheritance policy.
object
Policy id.
Child entity definition id.
Parent entity definition id.
Parent entity display name.
Parent reference field id on the child entity.
Parent reference field key.
Parent reference field display name.
Whether the policy is active.
Maximum propagation depth stored for future reconciliation.
When the child is an Association, whether inherited access continues to the opposite endpoint.
Opposite endpoint entity definition id when transit is available.
Opposite endpoint display name when transit is available.
Relation mappings.
Read model for one inherited access relation map.
object
Relation map id.
Parent relation definition id.
Parent relation definition key.
Parent relation definition display name.
Child relation definition id.
Child relation definition key.
Child relation definition display name.
Whether the map is active.
Display order.
Concurrency token.
Concurrency token.
Association endpoint and generated inverse binding metadata.
object
Binding identifier.
Association entity definition identifier.
Left endpoint target entity definition identifier.
Right endpoint target entity definition identifier.
Left required reference field on the association entity.
Right required reference field on the association entity.
Generated inverse field on the left endpoint entity.
Generated inverse field on the right endpoint entity.
Projection-entity configuration for one entity definition.
object
Projection-entity source member configuration.
object
Projection-entity field mapping rule.
object
Entity-level default runtime sort sequence.
Entity-level default runtime sort item.
object
Typed target path for a runtime list query sort item.
object
Reference path from the queried entity to the sortable terminal field or system field.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Default sort order.
Display-only computed fields available to table and card surfaces.
Display-only computed field metadata.
object
One ordered rule for a display-only computed field.
object
ID-only object-context facts materialized onto entity-instance read models.
Object-context fact configuration for one entity definition.
object
object
object
object
object
object
Example
{ "Data": { "AuditTrailRetentionMode": 0, "AccessModel": 0, "DisabledOperations": 0, "Tables": [ { "Fields": [ { "FieldType": 0, "ReferenceDeleteBehavior": 0, "AccessRules": [ { "Subject": { "SubjectType": 0 }, "AccessLevel": 0 } ], "SchemaSource": 0, "SystemRole": 0, "VisibleWhenOperationMode": 0, "RequiredWhenOperationMode": 0, "EditableWhenOperationMode": 0, "CalculationKind": 0, "ReferenceArchiveBehavior": 0, "ReferenceAuditRollupBehavior": 0, "SemanticRole": 0 } ], "SchemaSource": 0 } ], "RelationDefinitions": [ { "Semantic": 0, "Cardinality": 0, "SubjectMode": 0, "ResponsibilityGroups": [ { "Type": 0 } ] } ], "Permissions": [ { "Scope": 0, "Action": 0, "Subject": { "SubjectType": 0 } } ], "Statements": [ { "SchemaSource": 0 } ], "ValidationRules": [ { "SchemaSource": 0 } ], "PresentationRules": [ { "Target": 0, "SchemaSource": 0 } ], "SchemaSource": 0, "UsageType": 0, "Projection": { "ProjectionKind": 0, "OpenBehavior": 0, "Mappings": [ { "TargetKind": 0, "TransformKind": 0 } ] }, "DefaultSort": [ { "Target": { "Path": [ { "Special": 0 } ] }, "Direction": 0 } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}