Skip to content

Query instances.

POST
/api/workspace/entity/{entityIdOrKey}/instances/query
curl --request POST \
--url https://example.com/api/workspace/entity/example/instances/query \
--header 'Content-Type: application/json' \
--data '{ "Page": 1, "PageSize": 1, "ArchiveMode": 0, "Filter": { "Operator": 0, "Conditions": [ { "Field": { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" }, "Target": { "Path": [ { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" } ] }, "Operator": 0, "Values": [ { "Kind": 0, "Value": {}, "Variable": 0 } ], "RowsFilter": {}, "Spatial": { "ShapeKind": 0, "Center": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" }, "RadiusKm": 1, "BoundingBox": { "SouthWest": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" }, "NorthEast": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" } }, "Polygon": [ { "Latitude": 1, "Longitude": 1, "FullAddress": "example" } ] } } ], "Groups": [] }, "Sort": [ { "Field": { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" }, "Target": { "Path": [ { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" } ] }, "Direction": 0 } ], "Include": [ { "Path": [ "example" ] } ], "QueryStateSource": 0, "BaseSort": [ { "Field": { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" }, "Target": { "Path": [ { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" } ] }, "Direction": 0 } ], "ExpectedContainerSurfaceId": "example", "ExpectedTableSurfaceId": "example" }'

Queries entity instances for one runtime entity definition. The list is always filtered by runtime security in SQL before materialization. Fields denied by the current Security configuration are omitted from the response payload.

  • None
entityIdOrKey
required
string

Entity definition identifier or normalized entity key.

access_token
string

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

JSON query model with paging, filtering, sorting, and include placeholders.

Request payload for runtime entity-instance list queries and table bootstrap queries.

object
Page

One-based page number. Values below 1 are normalized to 1.

integer format: int32
PageSize

Requested page size. The default is 25 and the maximum is 250.

integer format: int32
ArchiveMode
integer format: int32
Allowed values: 0 1 2
Filter

One nested logical filter group.

object
Operator
integer format: int32
Allowed values: 0 1
Conditions

Direct conditions inside this group.

Array<object>
nullable

One leaf condition in the runtime list query tree.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed server-side condition target. The first segment belongs to the queried entity; every intermediate segment must be a readable primary-table reference, and the terminal segment determines the field type, supported operators, and operand shape.

object
Path

Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Operator
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
Values

Operand list for the selected operator.

Array<object>
nullable

One query operand.

object
Kind
integer format: int32
Allowed values: 0 1
Value

Literal JSON value used when Moltaro.Entity.Instances.Requests.EntityInstanceQueryOperandRequest.Kind is Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value. Select and enum fields accept the string option key; numeric enum ordinals and display labels are not operands.

object
Variable
integer format: int32
Allowed values: 0 1
RowsFilter
object recursive
Spatial

Spatial operand for address-style runtime query conditions.

object
ShapeKind
integer format: int32
Allowed values: 0 1 2
Center

Geographic point in WGS84 coordinates.

object
Latitude

Latitude in decimal degrees.

number format: double
Longitude

Longitude in decimal degrees.

number format: double
FullAddress

Optional display address selected by the user.

string
nullable
RadiusKm

Radius in kilometers for radius-based queries.

number format: double
nullable
BoundingBox

Reserved WGS84 bounding box for future spatial queries.

object
SouthWest

Geographic point in WGS84 coordinates.

object
Latitude

Latitude in decimal degrees.

number format: double
Longitude

Longitude in decimal degrees.

number format: double
FullAddress

Optional display address selected by the user.

string
nullable
NorthEast

Geographic point in WGS84 coordinates.

object
Latitude

Latitude in decimal degrees.

number format: double
Longitude

Longitude in decimal degrees.

number format: double
FullAddress

Optional display address selected by the user.

string
nullable
Polygon

Reserved polygon payload for future spatial queries.

Array<object>
nullable

Geographic point in WGS84 coordinates.

object
Latitude

Latitude in decimal degrees.

number format: double
Longitude

Longitude in decimal degrees.

number format: double
FullAddress

Optional display address selected by the user.

string
nullable
Groups
Array<object> recursive
Sort

Optional multi-level sort list. Supports up to three sort items.

Array<object>
nullable

One sort item in the runtime list query.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object
Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1
Include

Optional reference include paths materialized into reference projected values.

Array<object>
nullable

One post-load reference include path.

object
Path

Runtime field key path segments. Paths resolve through primary-table reference fields only.

Array<string>
nullable
QueryStateSource
integer format: int32
Allowed values: 0 1 2 3 4
BaseSort

Sort owned by the complete saved/global/share query state. Moltaro.Entity.Instances.Requests.EntityInstanceListQueryRequest.Sort remains the current explicit user request and therefore has higher precedence. Ordinary list APIs ignore this value.

Array<object>
nullable

One sort item in the runtime list query.

object
Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object
Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>
nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object
FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string
nullable
FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string
nullable
Special
integer format: int32
Allowed values: 0 1
StatementId

Statement identifier resolved through the runtime statement index.

string
nullable
StatementKey

Statement key resolved through the runtime normalized-key index.

string
nullable
ObjectContextFactId

Configured object-context fact identifier.

string
nullable
ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string
nullable
Direction
integer format: int32
Allowed values: 0 1
ExpectedContainerSurfaceId

Optional Entity List Page identity captured by a UI preflight. Hosted table endpoints reject the request when the route now resolves to a different container, including when that replacement still selects the same Table Surface. An empty value explicitly expects no resolved container; null disables the check for older clients and non-hosted requests.

string
nullable
ExpectedTableSurfaceId

Optional Table Surface identity captured by a UI preflight. Hosted table and generic Reference picker endpoints reject the request when the host now resolves to a different table, so a filter scoped to one surface is never executed against another. An empty value explicitly expects no resolved table; null disables the check for older clients. Ordinary list APIs ignore this value.

string
nullable

OK

Media typeapplication/json
object
Data

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance. List payloads include the first few tags only.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

Readable primary-table scalar fields keyed by field key. Denied fields are omitted.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
PlainTextPreview

Safe compact visible-text representation of a Markdown value.

object
Text

Visible text when available.

string
nullable
IsTruncated

Whether the visible text was shortened for compact presentation.

boolean
State
integer format: int32
Allowed values: 0 1 2 3
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Display-safe common responsibility subject in Entity runtime payloads.

object
SubjectType

Common subject discriminator: User or ResponsibilityGroup.

string
nullable
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
EffectiveFrom

Inclusive start of the responsibility interval.

string format: date-time
nullable
EffectiveTo

Exclusive end of the responsibility interval, or null for an open interval.

string format: date-time
nullable
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ProjectionSource

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object
Resource
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>
nullable

Current safe state of one Business Invariant target for one resource.

object
InvariantKey

Stable invariant key.

string
nullable
TargetKey

Stable target key within the invariant.

string
nullable
IsActive

Whether the invariant is active for the current resource state.

boolean
SafeMessage

Localized safe active-state message, or null when inactive.

string
nullable
Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object
key
additional properties

Composed current decision for one applicable object operation.

object
OperationKey

Stable Object Operation Catalog key.

string
nullable
IsAllowed

Whether all independent authorities allow the operation.

boolean
Denials

Deterministically ordered safe denial details.

Array<object>
nullable

One safe denial contributing to a composed object-operation decision.

object
Source

Identifies the independent authority that denied an object operation.

integer format: int32
Allowed values: 0 1 2 3
SourceKey

Stable source identity, such as an invariant key or domain policy key.

string
nullable
ReasonCode

Stable machine-readable reason code.

string
nullable
SafeMessage

Non-empty localized safe message.

string
nullable
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment columns.

Array<object>
nullable

Active common responsibility definition published to Entity runtime surfaces.

object
ResponsibilityDefinitionId

Stable common responsibility definition identifier.

string
nullable
ResponsibilityKey

Stable definition-scoped responsibility key.

string
nullable
DisplayName

User-facing responsibility name.

string
nullable
Description

Optional user-facing description.

string
nullable
Cardinality

Common cardinality discriminator: One or Many.

string
nullable
Required

Whether an active resource must always have an assigned responsible subject.

boolean
SubjectMode

Common subject-mode discriminator: User, Group or UserOrGroup.

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": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0,
"PlainTextPreview": {
"State": 0
}
}
},
"ObjectInvariant": {
"Operations": {
"additionalProperty": {
"Denials": [
{
"Source": 0
}
]
}
}
}
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance. List payloads include the first few tags only.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

Readable primary-table scalar fields keyed by field key. Denied fields are omitted.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
PlainTextPreview

Safe compact visible-text representation of a Markdown value.

object
Text

Visible text when available.

string
nullable
IsTruncated

Whether the visible text was shortened for compact presentation.

boolean
State
integer format: int32
Allowed values: 0 1 2 3
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Display-safe common responsibility subject in Entity runtime payloads.

object
SubjectType

Common subject discriminator: User or ResponsibilityGroup.

string
nullable
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
EffectiveFrom

Inclusive start of the responsibility interval.

string format: date-time
nullable
EffectiveTo

Exclusive end of the responsibility interval, or null for an open interval.

string format: date-time
nullable
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ProjectionSource

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object
Resource
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>
nullable

Current safe state of one Business Invariant target for one resource.

object
InvariantKey

Stable invariant key.

string
nullable
TargetKey

Stable target key within the invariant.

string
nullable
IsActive

Whether the invariant is active for the current resource state.

boolean
SafeMessage

Localized safe active-state message, or null when inactive.

string
nullable
Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object
key
additional properties

Composed current decision for one applicable object operation.

object
OperationKey

Stable Object Operation Catalog key.

string
nullable
IsAllowed

Whether all independent authorities allow the operation.

boolean
Denials

Deterministically ordered safe denial details.

Array<object>
nullable

One safe denial contributing to a composed object-operation decision.

object
Source

Identifies the independent authority that denied an object operation.

integer format: int32
Allowed values: 0 1 2 3
SourceKey

Stable source identity, such as an invariant key or domain policy key.

string
nullable
ReasonCode

Stable machine-readable reason code.

string
nullable
SafeMessage

Non-empty localized safe message.

string
nullable
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment columns.

Array<object>
nullable

Active common responsibility definition published to Entity runtime surfaces.

object
ResponsibilityDefinitionId

Stable common responsibility definition identifier.

string
nullable
ResponsibilityKey

Stable definition-scoped responsibility key.

string
nullable
DisplayName

User-facing responsibility name.

string
nullable
Description

Optional user-facing description.

string
nullable
Cardinality

Common cardinality discriminator: One or Many.

string
nullable
Required

Whether an active resource must always have an assigned responsible subject.

boolean
SubjectMode

Common subject-mode discriminator: User, Group or UserOrGroup.

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": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0,
"PlainTextPreview": {
"State": 0
}
}
},
"ObjectInvariant": {
"Operations": {
"additionalProperty": {
"Denials": [
{
"Source": 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"
}

Not Found

Media typeapplication/json
object
Data

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance. List payloads include the first few tags only.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

Readable primary-table scalar fields keyed by field key. Denied fields are omitted.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
PlainTextPreview

Safe compact visible-text representation of a Markdown value.

object
Text

Visible text when available.

string
nullable
IsTruncated

Whether the visible text was shortened for compact presentation.

boolean
State
integer format: int32
Allowed values: 0 1 2 3
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Display-safe common responsibility subject in Entity runtime payloads.

object
SubjectType

Common subject discriminator: User or ResponsibilityGroup.

string
nullable
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
EffectiveFrom

Inclusive start of the responsibility interval.

string format: date-time
nullable
EffectiveTo

Exclusive end of the responsibility interval, or null for an open interval.

string format: date-time
nullable
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ProjectionSource

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object
Resource
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>
nullable

Current safe state of one Business Invariant target for one resource.

object
InvariantKey

Stable invariant key.

string
nullable
TargetKey

Stable target key within the invariant.

string
nullable
IsActive

Whether the invariant is active for the current resource state.

boolean
SafeMessage

Localized safe active-state message, or null when inactive.

string
nullable
Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object
key
additional properties

Composed current decision for one applicable object operation.

object
OperationKey

Stable Object Operation Catalog key.

string
nullable
IsAllowed

Whether all independent authorities allow the operation.

boolean
Denials

Deterministically ordered safe denial details.

Array<object>
nullable

One safe denial contributing to a composed object-operation decision.

object
Source

Identifies the independent authority that denied an object operation.

integer format: int32
Allowed values: 0 1 2 3
SourceKey

Stable source identity, such as an invariant key or domain policy key.

string
nullable
ReasonCode

Stable machine-readable reason code.

string
nullable
SafeMessage

Non-empty localized safe message.

string
nullable
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment columns.

Array<object>
nullable

Active common responsibility definition published to Entity runtime surfaces.

object
ResponsibilityDefinitionId

Stable common responsibility definition identifier.

string
nullable
ResponsibilityKey

Stable definition-scoped responsibility key.

string
nullable
DisplayName

User-facing responsibility name.

string
nullable
Description

Optional user-facing description.

string
nullable
Cardinality

Common cardinality discriminator: One or Many.

string
nullable
Required

Whether an active resource must always have an assigned responsible subject.

boolean
SubjectMode

Common subject-mode discriminator: User, Group or UserOrGroup.

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": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0,
"PlainTextPreview": {
"State": 0
}
}
},
"ObjectInvariant": {
"Operations": {
"additionalProperty": {
"Denials": [
{
"Source": 0
}
]
}
}
}
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Conflict

Media typeapplication/json
object
Data

Paginated entity-instance response for one runtime entity definition.

object
Items

Current page of instance summaries.

Array<object>
nullable

List item for one entity instance.

object
Id

Instance identifier.

string
nullable
Number

Server-generated entity number.

string
nullable
DisplayName

Resolved entity display name or fallback number.

string
nullable
Subtitle

Resolved entity subtitle from the presentation cache.

string
nullable
CreatedAt

Instance creation timestamp.

string format: date-time
CreatedByUserId

Creating user identifier when available.

string
nullable
ModifiedAt

Last modification timestamp when available.

string format: date-time
nullable
ModifiedByUserId

Last modifying user identifier when available.

string
nullable
ArchivedAt

Archive timestamp when the instance is archived.

string format: date-time
nullable
ArchivedByUserId

Archiving user identifier when available.

string
nullable
LastComment

Compact summary of the latest comment on an entity instance.

object
Id

Comment identifier.

string
nullable
CommentText

Comment text.

string
nullable
CreatedByUserId

Comment author identifier.

string
nullable
CreatedByUserName

Comment author display name.

string
nullable
CreatedAt

Comment creation timestamp.

string format: date-time
Tags

Visible tags for the instance. List payloads include the first few tags only.

Array<object>
nullable

Compact tag details for one entity instance.

object
Id

Tag identifier.

string
nullable
TagName

Tag name.

string
nullable
Color

Optional color value.

string
nullable
Category

Optional category.

string
nullable
TagCount

Total number of tags on the instance.

integer format: int32
LastActivityDateTime

Last activity timestamp for the instance.

string format: date-time
RowVersion

Runtime row-version token from the primary table.

string format: uuid
Fields

Readable primary-table scalar fields keyed by field key. Denied fields are omitted.

object
key
additional properties

Field envelope for runtime entity-instance responses.

object
State
integer format: int32
Allowed values: 0 1
Value

Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.

object
PlainTextPreview

Safe compact visible-text representation of a Markdown value.

object
Text

Visible text when available.

string
nullable
IsTruncated

Whether the visible text was shortened for compact presentation.

boolean
State
integer format: int32
Allowed values: 0 1 2 3
Predicates

Runtime-evaluated statement results keyed by statement identifier.

object
key
additional properties
boolean
Permissions

Item-level permissions for one entity instance.

object
CanRead

Whether the caller can read the active instance.

boolean
CanReadArchive

Whether the caller can read the instance while it is archived.

boolean
CanReadChangesHistory

Whether the caller can read the change history for this instance.

boolean
CanReadComments

Whether comments can be viewed for this instance.

boolean
CanReadTags

Whether tags can be viewed for this instance.

boolean
CanReadAttachments

Whether attachments can be viewed for this instance.

boolean
Assignments

Relation assignments keyed by relation key for record-scoped entities.

object
key
additional properties
Array<object>

Display-safe common responsibility subject in Entity runtime payloads.

object
SubjectType

Common subject discriminator: User or ResponsibilityGroup.

string
nullable
SubjectId

Assigned subject identifier.

string
nullable
DisplayName

Display name resolved for the subject when available.

string
nullable
Description

Optional secondary subject description.

string
nullable
EffectiveFrom

Inclusive start of the responsibility interval.

string format: date-time
nullable
EffectiveTo

Exclusive end of the responsibility interval, or null for an open interval.

string format: date-time
nullable
MergeState

Merge state attached to entity instance payloads.

object
IsMergedAway
boolean
MergedIntoInstanceId
string
nullable
MergeOperationId
string
nullable
DisplayFields

Display-only computed fields keyed by display-field key.

object
key
additional properties
string
ProjectionSource

Display-only source member metadata for a projection row.

object
ProjectionMemberId
string
nullable
ReferenceFieldId
string
nullable
SourceEntityDefinitionId
string
nullable
Label
string
nullable
SourceEntityDisplayNameSingular
string
nullable
SourceEntityDisplayNamePlural
string
nullable
ObjectContextFacts

Provider-owned object-context facts keyed by provider key.

object
key
additional properties
object
ObjectInvariant

Resource-neutral current invariant state and complete object-operation decision set.

object
Resource
object
ModuleKey
string
nullable
ResourceKind
string
nullable
ContextResourceId
string
nullable
ResourceObjectId
string
nullable
BusinessInvariants

Current safe state of every applicable enabled Business Invariant.

Array<object>
nullable

Current safe state of one Business Invariant target for one resource.

object
InvariantKey

Stable invariant key.

string
nullable
TargetKey

Stable target key within the invariant.

string
nullable
IsActive

Whether the invariant is active for the current resource state.

boolean
SafeMessage

Localized safe active-state message, or null when inactive.

string
nullable
Operations

Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.

object
key
additional properties

Composed current decision for one applicable object operation.

object
OperationKey

Stable Object Operation Catalog key.

string
nullable
IsAllowed

Whether all independent authorities allow the operation.

boolean
Denials

Deterministically ordered safe denial details.

Array<object>
nullable

One safe denial contributing to a composed object-operation decision.

object
Source

Identifies the independent authority that denied an object operation.

integer format: int32
Allowed values: 0 1 2 3
SourceKey

Stable source identity, such as an invariant key or domain policy key.

string
nullable
ReasonCode

Stable machine-readable reason code.

string
nullable
SafeMessage

Non-empty localized safe message.

string
nullable
TotalCount

Total accessible instance count for the active page filter.

integer format: int32
Page

One-based page number.

integer format: int32
PageSize

Requested page size after normalization.

integer format: int32
Permissions

Page-level permissions for entity instances.

object
CanCreate

Whether the caller can create a new instance for this entity definition.

boolean
CanReadActive

Whether the caller can read active instances for this entity definition.

boolean
CanReadArchive

Whether the caller can read archived instances for this entity definition.

boolean
CanReadChangesHistory

Whether the caller can read change history for this entity definition.

boolean
CanMerge

Whether the caller can potentially merge records for this entity definition.

boolean
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment columns.

Array<object>
nullable

Active common responsibility definition published to Entity runtime surfaces.

object
ResponsibilityDefinitionId

Stable common responsibility definition identifier.

string
nullable
ResponsibilityKey

Stable definition-scoped responsibility key.

string
nullable
DisplayName

User-facing responsibility name.

string
nullable
Description

Optional user-facing description.

string
nullable
Cardinality

Common cardinality discriminator: One or Many.

string
nullable
Required

Whether an active resource must always have an assigned responsible subject.

boolean
SubjectMode

Common subject-mode discriminator: User, Group or UserOrGroup.

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": {
"Items": [
{
"Fields": {
"additionalProperty": {
"State": 0,
"PlainTextPreview": {
"State": 0
}
}
},
"ObjectInvariant": {
"Operations": {
"additionalProperty": {
"Denials": [
{
"Source": 0
}
]
}
}
}
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}