Skip to content

Evaluate create-form mutation effects without saving a record.

POST
/api/workspace/entity/{entityIdOrKey}/instances/form-evaluation
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" } } }'
entityIdOrKey
required
string
access_token
string

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

Request payload for debounced entity form mutation-effect evaluation.

object
Mode
integer format: int32
Allowed values: 0 1 2
DraftFields
object
key
additional properties
ChangedFields
Array<string>
nullable
FieldOrigins
object
key
additional properties
integer format: int32
Allowed values: 0 1 2 3
ParentContext

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
EntityDefinitionId
required

Id of the parent Entity definition.

string
FormSurfaceId
required

Id of the parent Form surface.

string
ExpectedRevision
required

The Submission.Revision of the parent Form the client renders.

string
ItemId
required

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).

string
ParentInstanceId

Id of the existing parent record; null while the parent is created by the same Form.

string
nullable
ParentFields

Unsaved parent draft values by field key, as the parent Form evaluation takes them.

object
key
additional properties

OK

Media typeapplication/json
object
Data

Result of server-side form mutation-effect evaluation.

object
Patch

Canonical changed field values keyed by field key.

object
key
additional properties
ReferencePatchValues

Actor-shaped display and required projection payloads for scalar Reference values present in Patch.

object
key
additional properties

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
string
nullable
FieldOrigins

Authoritative value origins keyed by readable field key.

object
key
additional properties
integer format: int32
Allowed values: 0 1 2 3
LoadingFieldKeys

Fields affected by the evaluation generation.

Array<string>
nullable
FieldErrors

Field-scoped evaluation 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
Skips

Non-fatal evaluation diagnostics.

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
ParentReference

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
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": {
"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

Media typeapplication/json
object
Data

Result of server-side form mutation-effect evaluation.

object
Patch

Canonical changed field values keyed by field key.

object
key
additional properties
ReferencePatchValues

Actor-shaped display and required projection payloads for scalar Reference values present in Patch.

object
key
additional properties

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
string
nullable
FieldOrigins

Authoritative value origins keyed by readable field key.

object
key
additional properties
integer format: int32
Allowed values: 0 1 2 3
LoadingFieldKeys

Fields affected by the evaluation generation.

Array<string>
nullable
FieldErrors

Field-scoped evaluation 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
Skips

Non-fatal evaluation diagnostics.

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
ParentReference

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
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": {
"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

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

Result of server-side form mutation-effect evaluation.

object
Patch

Canonical changed field values keyed by field key.

object
key
additional properties
ReferencePatchValues

Actor-shaped display and required projection payloads for scalar Reference values present in Patch.

object
key
additional properties

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
string
nullable
FieldOrigins

Authoritative value origins keyed by readable field key.

object
key
additional properties
integer format: int32
Allowed values: 0 1 2 3
LoadingFieldKeys

Fields affected by the evaluation generation.

Array<string>
nullable
FieldErrors

Field-scoped evaluation 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
Skips

Non-fatal evaluation diagnostics.

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
ParentReference

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
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": {
"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

Media typeapplication/json
object
Data

Result of server-side form mutation-effect evaluation.

object
Patch

Canonical changed field values keyed by field key.

object
key
additional properties
ReferencePatchValues

Actor-shaped display and required projection payloads for scalar Reference values present in Patch.

object
key
additional properties

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
string
nullable
FieldOrigins

Authoritative value origins keyed by readable field key.

object
key
additional properties
integer format: int32
Allowed values: 0 1 2 3
LoadingFieldKeys

Fields affected by the evaluation generation.

Array<string>
nullable
FieldErrors

Field-scoped evaluation 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
Skips

Non-fatal evaluation diagnostics.

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
ParentReference

Compact runtime payload for one resolved or unresolved entity reference.

object
State
integer format: int32
Allowed values: 0 1 2
Id

Linked entity identifier when resolved.

string
nullable
Number

Linked entity number when resolved.

string
nullable
DisplayName

Linked entity display name from the presentation cache when resolved.

string
nullable
Subtitle

Linked entity subtitle from the presentation cache when resolved.

string
nullable
ProjectedValues

Projected primary-field scalar values and requested nested reference values keyed by target field key when resolved.

object
key
additional properties
nullable
EntityDefinitionId

Linked entity definition identifier when resolved.

string
nullable
ProjectedPlainTextPreviews

Compact server-created previews for projected Markdown fields, keyed by target field key.

object
key
additional properties

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
SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object
UsageType
integer format: int32
Allowed values: 0 1 2
SemanticType
string
nullable
LinkRegistrationKey
string
nullable
CellRegistrationKey
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": {
"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
}
]
}