Evaluate create-form mutation effects without saving a record.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/form-evaluation"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"Mode\": 0, \"DraftFields\": { \"additionalProperty\": \"example\" }, \"ChangedFields\": [ \"example\" ], \"FieldOrigins\": { \"additionalProperty\": 0 }, \"ParentContext\": { \"EntityDefinitionId\": \"example\", \"FormSurfaceId\": \"example\", \"ExpectedRevision\": \"example\", \"ItemId\": \"example\", \"ParentInstanceId\": \"example\", \"ParentFields\": { \"additionalProperty\": \"example\" } } }") { 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/form-evaluation';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Mode":0,"DraftFields":{"additionalProperty":"example"},"ChangedFields":["example"],"FieldOrigins":{"additionalProperty":0},"ParentContext":{"EntityDefinitionId":"example","FormSurfaceId":"example","ExpectedRevision":"example","ItemId":"example","ParentInstanceId":"example","ParentFields":{"additionalProperty":"example"}}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/workspace/entity/example/instances/form-evaluation \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Mode": 0, "DraftFields": { "additionalProperty": "example" }, "ChangedFields": [ "example" ], "FieldOrigins": { "additionalProperty": 0 }, "ParentContext": { "EntityDefinitionId": "example", "FormSurfaceId": "example", "ExpectedRevision": "example", "ItemId": "example", "ParentInstanceId": "example", "ParentFields": { "additionalProperty": "example" } } }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Request payload for debounced entity form mutation-effect evaluation.
object
object
object
The parent draft of a child draft in a Form with a WithParent section, sent with a child-scoped request made
before the Form is saved. The server builds the parent’s effective draft for the actor (defaults, effects and
calculations of the parent Form evaluation) and exposes it only as the record the child’s parent Reference points to;
the child’s parent Reference is set by the server. Preview only: nothing is written and nothing is granted, the Form
submission decides everything again.
object
Id of the parent Entity definition.
Id of the parent Form surface.
The Submission.Revision of the parent Form the client renders.
Id of a WithParent related-table item of the child’s relation (any repeated item of that relation; its
own child Form is the one the request runs on).
Id of the existing parent record; null while the parent is created by the same Form.
Unsaved parent draft values by field key, as the parent Form evaluation takes them.
object
Request payload for debounced entity form mutation-effect evaluation.
object
object
object
The parent draft of a child draft in a Form with a WithParent section, sent with a child-scoped request made
before the Form is saved. The server builds the parent’s effective draft for the actor (defaults, effects and
calculations of the parent Form evaluation) and exposes it only as the record the child’s parent Reference points to;
the child’s parent Reference is set by the server. Preview only: nothing is written and nothing is granted, the Form
submission decides everything again.
object
Id of the parent Entity definition.
Id of the parent Form surface.
The Submission.Revision of the parent Form the client renders.
Id of a WithParent related-table item of the child’s relation (any repeated item of that relation; its
own child Form is the one the request runs on).
Id of the existing parent record; null while the parent is created by the same Form.
Unsaved parent draft values by field key, as the parent Form evaluation takes them.
object
Request payload for debounced entity form mutation-effect evaluation.
object
object
object
The parent draft of a child draft in a Form with a WithParent section, sent with a child-scoped request made
before the Form is saved. The server builds the parent’s effective draft for the actor (defaults, effects and
calculations of the parent Form evaluation) and exposes it only as the record the child’s parent Reference points to;
the child’s parent Reference is set by the server. Preview only: nothing is written and nothing is granted, the Form
submission decides everything again.
object
Id of the parent Entity definition.
Id of the parent Form surface.
The Submission.Revision of the parent Form the client renders.
Id of a WithParent related-table item of the child’s relation (any repeated item of that relation; its
own child Form is the one the request runs on).
Id of the existing parent record; null while the parent is created by the same Form.
Unsaved parent draft values by field key, as the parent Form evaluation takes them.
object
Responses
Section titled “Responses”OK
object
Result of server-side form mutation-effect evaluation.
object
Canonical changed field values keyed by field key.
object
Actor-shaped display and required projection payloads for scalar Reference values present in Patch.
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Authoritative value origins keyed by readable field key.
object
Fields affected by the evaluation generation.
Field-scoped evaluation errors.
object
object
Non-fatal evaluation diagnostics.
object
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
object
object
object
object
Example
{ "Data": { "ReferencePatchValues": { "additionalProperty": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "FieldOrigins": { "additionalProperty": 0 }, "FieldErrors": [ { "Type": 0, "Severity": 0 } ], "Skips": [ { "Type": 0, "Severity": 0 } ], "ParentReference": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Result of server-side form mutation-effect evaluation.
object
Canonical changed field values keyed by field key.
object
Actor-shaped display and required projection payloads for scalar Reference values present in Patch.
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Authoritative value origins keyed by readable field key.
object
Fields affected by the evaluation generation.
Field-scoped evaluation errors.
object
object
Non-fatal evaluation diagnostics.
object
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
object
object
object
object
Example
{ "Data": { "ReferencePatchValues": { "additionalProperty": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "FieldOrigins": { "additionalProperty": 0 }, "FieldErrors": [ { "Type": 0, "Severity": 0 } ], "Skips": [ { "Type": 0, "Severity": 0 } ], "ParentReference": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 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
Result of server-side form mutation-effect evaluation.
object
Canonical changed field values keyed by field key.
object
Actor-shaped display and required projection payloads for scalar Reference values present in Patch.
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Authoritative value origins keyed by readable field key.
object
Fields affected by the evaluation generation.
Field-scoped evaluation errors.
object
object
Non-fatal evaluation diagnostics.
object
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
object
object
object
object
Example
{ "Data": { "ReferencePatchValues": { "additionalProperty": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "FieldOrigins": { "additionalProperty": 0 }, "FieldErrors": [ { "Type": 0, "Severity": 0 } ], "Skips": [ { "Type": 0, "Severity": 0 } ], "ParentReference": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Result of server-side form mutation-effect evaluation.
object
Canonical changed field values keyed by field key.
object
Actor-shaped display and required projection payloads for scalar Reference values present in Patch.
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Authoritative value origins keyed by readable field key.
object
Fields affected by the evaluation generation.
Field-scoped evaluation errors.
object
object
Non-fatal evaluation diagnostics.
object
object
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.
Compact server-created previews for projected Markdown fields, keyed by target field key.
object
Safe compact visible-text representation of a Markdown value.
object
Visible text when available.
Whether the visible text was shortened for compact presentation.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
object
object
object
object
Example
{ "Data": { "ReferencePatchValues": { "additionalProperty": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "FieldOrigins": { "additionalProperty": 0 }, "FieldErrors": [ { "Type": 0, "Severity": 0 } ], "Skips": [ { "Type": 0, "Severity": 0 } ], "ParentReference": { "State": 0, "ProjectedPlainTextPreviews": { "additionalProperty": { "State": 0 } }, "SemanticPresentation": { "UsageType": 0 } } }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}