Skip to content

Return instance.

GET
/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}
curl --request GET \
--url https://example.com/api/workspace/entity/example/instances/example

Returns one entity instance by identifier. Returns 404 when the entity definition or instance does not exist. Returns 403 when the instance exists but the caller does not have effective read access for the current archive state. Archived instances are returned only when the caller has effective ReadArchive access.

  • None
entityIdOrKey
required
string

Entity definition identifier or normalized entity key.

instanceId
required
string

Entity instance identifier.

include
Array<string>

Optional repeated dot-separated include paths.

access_token
string

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

OK

Media typeapplication/json
object
Data

Detailed entity-instance response.

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.

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

All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.

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
Assignments

Common responsibility subjects keyed by stable responsibility key.

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
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
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment sections.

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
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
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
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": {
"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

Detailed entity-instance response.

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.

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

All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.

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
Assignments

Common responsibility subjects keyed by stable responsibility key.

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
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
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment sections.

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
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
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
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": {
"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

Detailed entity-instance response.

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.

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

All runtime fields keyed by field key. User and role fields return compact reference models. Table fields return table metadata together with child rows.

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
Assignments

Common responsibility subjects keyed by stable responsibility key.

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
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
ResponsibilityDefinitions

Runtime relation metadata for record-scoped assignment sections.

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