Patch instance.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/example"), Content = new StringContent("{ \"Fields\": { \"additionalProperty\": {} }, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/entity/example/instances/example';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"Fields":{"additionalProperty":{}},"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/api/workspace/entity/example/instances/example \ --header 'Content-Type: application/json' \ --data '{ "Fields": { "additionalProperty": {} }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'PATCH uses tri-state field semantics: omitted keys are undefined and remain unchanged, explicit null clears a field,
and any other value replaces the stored value. Undefined fields do not pass through required validation.
Unauthorized field inputs are skipped and returned as warnings.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entity definition identifier or normalized entity key.
Entity instance identifier.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Partial mutation payload.
PATCH payload for a dynamic entity instance.
object
Dynamic field map keyed by field key.
Omitted keys are treated as undefined and remain unchanged.
Explicit null values clear the stored value.
Any other value replaces the stored value.
Required validation runs only for writable fields that participate in the current patch.
Table field rows may include a reserved top-level Id to update an existing child row in place.
object
object
Expected runtime row version of the instance being patched.
Examplegenerated
{ "Fields": { "additionalProperty": {} }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}PATCH payload for a dynamic entity instance.
object
Dynamic field map keyed by field key.
Omitted keys are treated as undefined and remain unchanged.
Explicit null values clear the stored value.
Any other value replaces the stored value.
Required validation runs only for writable fields that participate in the current patch.
Table field rows may include a reserved top-level Id to update an existing child row in place.
object
object
Expected runtime row version of the instance being patched.
Examplegenerated
{ "Fields": { "additionalProperty": {} }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}PATCH payload for a dynamic entity instance.
object
Dynamic field map keyed by field key.
Omitted keys are treated as undefined and remain unchanged.
Explicit null values clear the stored value.
Any other value replaces the stored value.
Required validation runs only for writable fields that participate in the current patch.
Table field rows may include a reserved top-level Id to update an existing child row in place.
object
object
Expected runtime row version of the instance being patched.
Examplegenerated
{ "Fields": { "additionalProperty": {} }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “Responses”OK
object
Mutation response for create, patch, archive, restore, and delete operations.
object
Affected instance identifier.
Current optimistic-concurrency token after the mutation completes. This is null after permanent delete.
Whether the active caller can read the instance after the mutation completes.
Detailed entity-instance response.
object
Instance identifier.
Server-generated entity number.
Resolved entity display name or fallback number.
Resolved entity subtitle from the presentation cache.
Instance creation timestamp.
Creating user identifier when available.
Last modification timestamp when available.
Last modifying user identifier when available.
Archive timestamp when the instance is archived.
Archiving user identifier when available.
Compact summary of the latest comment on an entity instance.
object
Comment identifier.
Comment text.
Comment author identifier.
Comment author display name.
Comment creation timestamp.
Visible tags for the instance.
Compact tag details for one entity instance.
object
Tag identifier.
Tag name.
Optional color value.
Optional category.
Total number of tags on the instance.
Last activity timestamp for the instance.
Runtime row-version token from the primary table.
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
Field envelope for runtime entity-instance responses.
object
Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.
object
Runtime-evaluated statement results keyed by statement identifier.
object
Relation assignments keyed by relation key for record-scoped entities.
object
Assignment target in runtime entity-instance payloads.
object
Assigned subject identifier.
Display name resolved for the assignment subject when available.
Optional secondary subject description.
Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.
Display-safe source metadata for a runtime assignment inherited from a parent record.
object
Parent entity definition identifier.
Parent entity user-facing display name.
Compact runtime payload for one resolved or unresolved entity reference.
object
Linked entity identifier when resolved.
Linked entity number when resolved.
Linked entity display name from the presentation cache when resolved.
Linked entity subtitle from the presentation cache when resolved.
Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.
object
Linked entity definition identifier when resolved.
Immediate source assignment relation identifier when available.
Immediate source assignment relation key when available.
Immediate source assignment relation display name when available.
Timestamp when the inherited assignment row was last recalculated.
Materialized inheritance depth.
Per-relation assignment mutation permissions keyed by relation key.
object
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Item-level permissions for one entity instance.
object
Whether the caller can read the active instance.
Whether the caller can patch the active instance.
Whether the caller can archive the active instance.
Whether the caller can permanently delete the instance after archival.
Whether the caller can restore the archived instance.
Whether the caller can merge this active instance with another active instance.
Whether the caller can read the instance while it is archived.
Whether the caller can read the change history for this instance.
Whether comments can be viewed for this instance.
Whether comments can be created for this instance.
Whether comments can be updated for this instance.
Whether comments can be deleted for this instance.
Whether tags can be viewed for this instance.
Whether tags can be created for this instance.
Whether tags can be updated for this instance.
Whether tags can be deleted for this instance.
Whether attachments can be viewed for this instance.
Whether attachments can be created for this instance.
Whether attachments can be updated for this instance.
Whether attachments can be deleted for this instance.
Runtime relation metadata for record-scoped assignment sections.
Runtime relation slot metadata for record-scoped assignments.
object
Relation definition identifier.
Relation definition key.
Relation display name.
Whether the relation must keep at least one assignment.
Relation display order.
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Merge state attached to entity instance payloads.
object
Display-only computed fields keyed by display-field key.
object
Provider-owned object-context facts keyed by provider key.
object
object
object
object
object
object
Example
{ "Data": { "Instance": { "Fields": { "additionalProperty": { "State": 0 } }, "Assignments": { "additionalProperty": [ { "SubjectType": 0, "Origin": 0, "InheritanceSource": { "ParentRecord": { "State": 0 } } } ] }, "AssignmentRelations": [ { "Cardinality": 0, "SubjectMode": 0 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Mutation response for create, patch, archive, restore, and delete operations.
object
Affected instance identifier.
Current optimistic-concurrency token after the mutation completes. This is null after permanent delete.
Whether the active caller can read the instance after the mutation completes.
Detailed entity-instance response.
object
Instance identifier.
Server-generated entity number.
Resolved entity display name or fallback number.
Resolved entity subtitle from the presentation cache.
Instance creation timestamp.
Creating user identifier when available.
Last modification timestamp when available.
Last modifying user identifier when available.
Archive timestamp when the instance is archived.
Archiving user identifier when available.
Compact summary of the latest comment on an entity instance.
object
Comment identifier.
Comment text.
Comment author identifier.
Comment author display name.
Comment creation timestamp.
Visible tags for the instance.
Compact tag details for one entity instance.
object
Tag identifier.
Tag name.
Optional color value.
Optional category.
Total number of tags on the instance.
Last activity timestamp for the instance.
Runtime row-version token from the primary table.
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
Field envelope for runtime entity-instance responses.
object
Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.
object
Runtime-evaluated statement results keyed by statement identifier.
object
Relation assignments keyed by relation key for record-scoped entities.
object
Assignment target in runtime entity-instance payloads.
object
Assigned subject identifier.
Display name resolved for the assignment subject when available.
Optional secondary subject description.
Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.
Display-safe source metadata for a runtime assignment inherited from a parent record.
object
Parent entity definition identifier.
Parent entity user-facing display name.
Compact runtime payload for one resolved or unresolved entity reference.
object
Linked entity identifier when resolved.
Linked entity number when resolved.
Linked entity display name from the presentation cache when resolved.
Linked entity subtitle from the presentation cache when resolved.
Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.
object
Linked entity definition identifier when resolved.
Immediate source assignment relation identifier when available.
Immediate source assignment relation key when available.
Immediate source assignment relation display name when available.
Timestamp when the inherited assignment row was last recalculated.
Materialized inheritance depth.
Per-relation assignment mutation permissions keyed by relation key.
object
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Item-level permissions for one entity instance.
object
Whether the caller can read the active instance.
Whether the caller can patch the active instance.
Whether the caller can archive the active instance.
Whether the caller can permanently delete the instance after archival.
Whether the caller can restore the archived instance.
Whether the caller can merge this active instance with another active instance.
Whether the caller can read the instance while it is archived.
Whether the caller can read the change history for this instance.
Whether comments can be viewed for this instance.
Whether comments can be created for this instance.
Whether comments can be updated for this instance.
Whether comments can be deleted for this instance.
Whether tags can be viewed for this instance.
Whether tags can be created for this instance.
Whether tags can be updated for this instance.
Whether tags can be deleted for this instance.
Whether attachments can be viewed for this instance.
Whether attachments can be created for this instance.
Whether attachments can be updated for this instance.
Whether attachments can be deleted for this instance.
Runtime relation metadata for record-scoped assignment sections.
Runtime relation slot metadata for record-scoped assignments.
object
Relation definition identifier.
Relation definition key.
Relation display name.
Whether the relation must keep at least one assignment.
Relation display order.
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Merge state attached to entity instance payloads.
object
Display-only computed fields keyed by display-field key.
object
Provider-owned object-context facts keyed by provider key.
object
object
object
object
object
object
Example
{ "Data": { "Instance": { "Fields": { "additionalProperty": { "State": 0 } }, "Assignments": { "additionalProperty": [ { "SubjectType": 0, "Origin": 0, "InheritanceSource": { "ParentRecord": { "State": 0 } } } ] }, "AssignmentRelations": [ { "Cardinality": 0, "SubjectMode": 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
Mutation response for create, patch, archive, restore, and delete operations.
object
Affected instance identifier.
Current optimistic-concurrency token after the mutation completes. This is null after permanent delete.
Whether the active caller can read the instance after the mutation completes.
Detailed entity-instance response.
object
Instance identifier.
Server-generated entity number.
Resolved entity display name or fallback number.
Resolved entity subtitle from the presentation cache.
Instance creation timestamp.
Creating user identifier when available.
Last modification timestamp when available.
Last modifying user identifier when available.
Archive timestamp when the instance is archived.
Archiving user identifier when available.
Compact summary of the latest comment on an entity instance.
object
Comment identifier.
Comment text.
Comment author identifier.
Comment author display name.
Comment creation timestamp.
Visible tags for the instance.
Compact tag details for one entity instance.
object
Tag identifier.
Tag name.
Optional color value.
Optional category.
Total number of tags on the instance.
Last activity timestamp for the instance.
Runtime row-version token from the primary table.
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
Field envelope for runtime entity-instance responses.
object
Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.
object
Runtime-evaluated statement results keyed by statement identifier.
object
Relation assignments keyed by relation key for record-scoped entities.
object
Assignment target in runtime entity-instance payloads.
object
Assigned subject identifier.
Display name resolved for the assignment subject when available.
Optional secondary subject description.
Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.
Display-safe source metadata for a runtime assignment inherited from a parent record.
object
Parent entity definition identifier.
Parent entity user-facing display name.
Compact runtime payload for one resolved or unresolved entity reference.
object
Linked entity identifier when resolved.
Linked entity number when resolved.
Linked entity display name from the presentation cache when resolved.
Linked entity subtitle from the presentation cache when resolved.
Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.
object
Linked entity definition identifier when resolved.
Immediate source assignment relation identifier when available.
Immediate source assignment relation key when available.
Immediate source assignment relation display name when available.
Timestamp when the inherited assignment row was last recalculated.
Materialized inheritance depth.
Per-relation assignment mutation permissions keyed by relation key.
object
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Item-level permissions for one entity instance.
object
Whether the caller can read the active instance.
Whether the caller can patch the active instance.
Whether the caller can archive the active instance.
Whether the caller can permanently delete the instance after archival.
Whether the caller can restore the archived instance.
Whether the caller can merge this active instance with another active instance.
Whether the caller can read the instance while it is archived.
Whether the caller can read the change history for this instance.
Whether comments can be viewed for this instance.
Whether comments can be created for this instance.
Whether comments can be updated for this instance.
Whether comments can be deleted for this instance.
Whether tags can be viewed for this instance.
Whether tags can be created for this instance.
Whether tags can be updated for this instance.
Whether tags can be deleted for this instance.
Whether attachments can be viewed for this instance.
Whether attachments can be created for this instance.
Whether attachments can be updated for this instance.
Whether attachments can be deleted for this instance.
Runtime relation metadata for record-scoped assignment sections.
Runtime relation slot metadata for record-scoped assignments.
object
Relation definition identifier.
Relation definition key.
Relation display name.
Whether the relation must keep at least one assignment.
Relation display order.
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Merge state attached to entity instance payloads.
object
Display-only computed fields keyed by display-field key.
object
Provider-owned object-context facts keyed by provider key.
object
object
object
object
object
object
Example
{ "Data": { "Instance": { "Fields": { "additionalProperty": { "State": 0 } }, "Assignments": { "additionalProperty": [ { "SubjectType": 0, "Origin": 0, "InheritanceSource": { "ParentRecord": { "State": 0 } } } ] }, "AssignmentRelations": [ { "Cardinality": 0, "SubjectMode": 0 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Mutation response for create, patch, archive, restore, and delete operations.
object
Affected instance identifier.
Current optimistic-concurrency token after the mutation completes. This is null after permanent delete.
Whether the active caller can read the instance after the mutation completes.
Detailed entity-instance response.
object
Instance identifier.
Server-generated entity number.
Resolved entity display name or fallback number.
Resolved entity subtitle from the presentation cache.
Instance creation timestamp.
Creating user identifier when available.
Last modification timestamp when available.
Last modifying user identifier when available.
Archive timestamp when the instance is archived.
Archiving user identifier when available.
Compact summary of the latest comment on an entity instance.
object
Comment identifier.
Comment text.
Comment author identifier.
Comment author display name.
Comment creation timestamp.
Visible tags for the instance.
Compact tag details for one entity instance.
object
Tag identifier.
Tag name.
Optional color value.
Optional category.
Total number of tags on the instance.
Last activity timestamp for the instance.
Runtime row-version token from the primary table.
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
Field envelope for runtime entity-instance responses.
object
Canonical stored value for the field when State is Moltaro.Enums.EntityInstanceFieldStateEnum.Value.
object
Runtime-evaluated statement results keyed by statement identifier.
object
Relation assignments keyed by relation key for record-scoped entities.
object
Assignment target in runtime entity-instance payloads.
object
Assigned subject identifier.
Display name resolved for the assignment subject when available.
Optional secondary subject description.
Whether the assignment row is managed by Moltaro runtime logic instead of direct user mutation.
Display-safe source metadata for a runtime assignment inherited from a parent record.
object
Parent entity definition identifier.
Parent entity user-facing display name.
Compact runtime payload for one resolved or unresolved entity reference.
object
Linked entity identifier when resolved.
Linked entity number when resolved.
Linked entity display name from the presentation cache when resolved.
Linked entity subtitle from the presentation cache when resolved.
Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.
object
Linked entity definition identifier when resolved.
Immediate source assignment relation identifier when available.
Immediate source assignment relation key when available.
Immediate source assignment relation display name when available.
Timestamp when the inherited assignment row was last recalculated.
Materialized inheritance depth.
Per-relation assignment mutation permissions keyed by relation key.
object
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Item-level permissions for one entity instance.
object
Whether the caller can read the active instance.
Whether the caller can patch the active instance.
Whether the caller can archive the active instance.
Whether the caller can permanently delete the instance after archival.
Whether the caller can restore the archived instance.
Whether the caller can merge this active instance with another active instance.
Whether the caller can read the instance while it is archived.
Whether the caller can read the change history for this instance.
Whether comments can be viewed for this instance.
Whether comments can be created for this instance.
Whether comments can be updated for this instance.
Whether comments can be deleted for this instance.
Whether tags can be viewed for this instance.
Whether tags can be created for this instance.
Whether tags can be updated for this instance.
Whether tags can be deleted for this instance.
Whether attachments can be viewed for this instance.
Whether attachments can be created for this instance.
Whether attachments can be updated for this instance.
Whether attachments can be deleted for this instance.
Runtime relation metadata for record-scoped assignment sections.
Runtime relation slot metadata for record-scoped assignments.
object
Relation definition identifier.
Relation definition key.
Relation display name.
Whether the relation must keep at least one assignment.
Relation display order.
Server-computed mutation permissions for one relation slot on one entity instance.
object
Whether the caller can replace the assignment set for the relation slot.
Merge state attached to entity instance payloads.
object
Display-only computed fields keyed by display-field key.
object
Provider-owned object-context facts keyed by provider key.
object
object
object
object
object
object
Example
{ "Data": { "Instance": { "Fields": { "additionalProperty": { "State": 0 } }, "Assignments": { "additionalProperty": [ { "SubjectType": 0, "Origin": 0, "InheritanceSource": { "ParentRecord": { "State": 0 } } } ] }, "AssignmentRelations": [ { "Cardinality": 0, "SubjectMode": 0 } ] } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}