Skip to content

List mutation effects for one entity definition.

GET
/api/workspace/admin/entity-definitions/{entityDefinitionId}/mutation-effects
curl --request GET \
--url https://example.com/api/workspace/admin/entity-definitions/example/mutation-effects
  • None
entityDefinitionId
required
string
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
Array<object>
nullable

Editable metadata for one mutation effect.

object
Id

Mutation effect identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
TargetFieldId

Identifier of the field the effect writes to.

string
nullable
TargetFieldKey

Key of the field the effect writes to.

string
nullable
TargetFieldDisplayName

Display name of the field the effect writes to.

string
nullable
SourcePath

Source value path copied into the target field when the effect fires.

string
nullable
TriggerFieldIds

Identifiers of the fields whose changes trigger the effect.

Array<string>
nullable
TriggerFieldKeys

Keys of the fields whose changes trigger the effect.

Array<string>
nullable
ApplyOnMode
integer format: int32
Allowed values: 0 1 2
AssignmentMode
integer format: int32
Allowed values: 0 1
SortOrder

Execution order among the entity’s mutation effects.

integer format: int32
IsEnabled

Whether the effect is active.

boolean
RowVersion

Concurrency token.

string format: uuid
ApplyWhen

Optional typed condition controlling whether the effect contributes a value. Null means always; false conditions can select a later fallback or clear an effect-owned target.

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": [
{
"ApplyOnMode": 0,
"AssignmentMode": 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
Array<object>
nullable

Editable metadata for one mutation effect.

object
Id

Mutation effect identifier.

string
nullable
EntityDefinitionId

Owning entity definition identifier.

string
nullable
TargetFieldId

Identifier of the field the effect writes to.

string
nullable
TargetFieldKey

Key of the field the effect writes to.

string
nullable
TargetFieldDisplayName

Display name of the field the effect writes to.

string
nullable
SourcePath

Source value path copied into the target field when the effect fires.

string
nullable
TriggerFieldIds

Identifiers of the fields whose changes trigger the effect.

Array<string>
nullable
TriggerFieldKeys

Keys of the fields whose changes trigger the effect.

Array<string>
nullable
ApplyOnMode
integer format: int32
Allowed values: 0 1 2
AssignmentMode
integer format: int32
Allowed values: 0 1
SortOrder

Execution order among the entity’s mutation effects.

integer format: int32
IsEnabled

Whether the effect is active.

boolean
RowVersion

Concurrency token.

string format: uuid
ApplyWhen

Optional typed condition controlling whether the effect contributes a value. Null means always; false conditions can select a later fallback or clear an effect-owned target.

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": [
{
"ApplyOnMode": 0,
"AssignmentMode": 0
}
],
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}