Skip to content

Validate a Reference Eligibility expression without saving it.

POST
/api/workspace/admin/entity-fields/{fieldId}/reference-eligibility/validate
curl --request POST \
--url https://example.com/api/workspace/admin/entity-fields/example/reference-eligibility/validate \
--header 'Content-Type: application/json' \
--data '{ "Expression": "example" }'
  • None
fieldId
required
string
access_token
string

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

Request to validate a Reference Eligibility expression without saving it.

object
Expression
required

Expression authored against Current and Candidate.

string
Examplegenerated
{
"Expression": "example"
}

OK

Media typeapplication/json
object
Data

Dry-run result for a Reference Eligibility expression.

object
Valid

Whether the expression and metadata bind successfully.

boolean
Errors

Structured compiler diagnostics.

Array<object>
nullable

Structured Reference Eligibility compiler diagnostic.

object
Field

Request field or canonical operand associated with the error.

string
nullable
Message

Localized diagnostic text.

string
nullable
Code

Stable diagnostic code.

string
nullable
Token

Optional offending token.

string
nullable
Dependencies

Detected dependencies when validation succeeds.

Array<object>
nullable

Compiler-owned Reference Eligibility dependency.

object
Kind
integer format: int32
Allowed values: 0 1 2 3 4 5
CanonicalPath

Canonical Current or Candidate operand path.

string
nullable
RootFieldDefinitionId

Direct root field identifier when one exists.

string
nullable
ReferencedEntityDefinitionId

Definition containing the bound operand.

string
nullable
ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string
nullable
DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean
DrivesContributorValidation

Whether contributor changes require reverse validation.

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

Bad Request

Media typeapplication/json
object
Data

Dry-run result for a Reference Eligibility expression.

object
Valid

Whether the expression and metadata bind successfully.

boolean
Errors

Structured compiler diagnostics.

Array<object>
nullable

Structured Reference Eligibility compiler diagnostic.

object
Field

Request field or canonical operand associated with the error.

string
nullable
Message

Localized diagnostic text.

string
nullable
Code

Stable diagnostic code.

string
nullable
Token

Optional offending token.

string
nullable
Dependencies

Detected dependencies when validation succeeds.

Array<object>
nullable

Compiler-owned Reference Eligibility dependency.

object
Kind
integer format: int32
Allowed values: 0 1 2 3 4 5
CanonicalPath

Canonical Current or Candidate operand path.

string
nullable
RootFieldDefinitionId

Direct root field identifier when one exists.

string
nullable
ReferencedEntityDefinitionId

Definition containing the bound operand.

string
nullable
ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string
nullable
DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean
DrivesContributorValidation

Whether contributor changes require reverse validation.

boolean
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": {
"Dependencies": [
{
"Kind": 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

Dry-run result for a Reference Eligibility expression.

object
Valid

Whether the expression and metadata bind successfully.

boolean
Errors

Structured compiler diagnostics.

Array<object>
nullable

Structured Reference Eligibility compiler diagnostic.

object
Field

Request field or canonical operand associated with the error.

string
nullable
Message

Localized diagnostic text.

string
nullable
Code

Stable diagnostic code.

string
nullable
Token

Optional offending token.

string
nullable
Dependencies

Detected dependencies when validation succeeds.

Array<object>
nullable

Compiler-owned Reference Eligibility dependency.

object
Kind
integer format: int32
Allowed values: 0 1 2 3 4 5
CanonicalPath

Canonical Current or Candidate operand path.

string
nullable
RootFieldDefinitionId

Direct root field identifier when one exists.

string
nullable
ReferencedEntityDefinitionId

Definition containing the bound operand.

string
nullable
ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string
nullable
DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean
DrivesContributorValidation

Whether contributor changes require reverse validation.

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

Service Unavailable

Media typeapplication/json
object
Data

Dry-run result for a Reference Eligibility expression.

object
Valid

Whether the expression and metadata bind successfully.

boolean
Errors

Structured compiler diagnostics.

Array<object>
nullable

Structured Reference Eligibility compiler diagnostic.

object
Field

Request field or canonical operand associated with the error.

string
nullable
Message

Localized diagnostic text.

string
nullable
Code

Stable diagnostic code.

string
nullable
Token

Optional offending token.

string
nullable
Dependencies

Detected dependencies when validation succeeds.

Array<object>
nullable

Compiler-owned Reference Eligibility dependency.

object
Kind
integer format: int32
Allowed values: 0 1 2 3 4 5
CanonicalPath

Canonical Current or Candidate operand path.

string
nullable
RootFieldDefinitionId

Direct root field identifier when one exists.

string
nullable
ReferencedEntityDefinitionId

Definition containing the bound operand.

string
nullable
ReferencedFieldDefinitionId

Bound field identifier, or null for immutable system identity.

string
nullable
DrivesSelectionContext

Whether the dependency supplies Current selection context.

boolean
DrivesContributorValidation

Whether contributor changes require reverse validation.

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