Skip to content

Return Reference Eligibility metadata owned by one dependent Reference field.

GET
/api/workspace/admin/entity-fields/{fieldId}/reference-eligibility
curl --request GET \
--url https://example.com/api/workspace/admin/entity-fields/example/reference-eligibility
  • None
fieldId
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

Field-owned Reference Eligibility configuration.

object
Id

Stable rule identifier.

string
nullable
EntityDefinitionId

Identifier of the source entity definition.

string
nullable
TargetFieldDefinitionId

Identifier of the dependent Reference field.

string
nullable
Expression

Eligibility expression authored against Current and Candidate.

string
nullable
Message

Optional default failure message.

string
nullable
MessageTranslations

Optional localized failure messages keyed by supported locale.

object
key
additional properties
string
Enabled

Whether the rule participates in runtime enforcement.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Owning Net Package identifier when package-owned.

string
nullable
SourcePackageId

Owning package artifact identifier when package-owned.

string
nullable
SourceStableId

Stable source identifier when package-owned.

string
nullable
RowVersion

Optimistic concurrency token.

string format: uuid
Dependencies

Compiler-owned dependency summary.

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": {
"SchemaSource": 0,
"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

Field-owned Reference Eligibility configuration.

object
Id

Stable rule identifier.

string
nullable
EntityDefinitionId

Identifier of the source entity definition.

string
nullable
TargetFieldDefinitionId

Identifier of the dependent Reference field.

string
nullable
Expression

Eligibility expression authored against Current and Candidate.

string
nullable
Message

Optional default failure message.

string
nullable
MessageTranslations

Optional localized failure messages keyed by supported locale.

object
key
additional properties
string
Enabled

Whether the rule participates in runtime enforcement.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Owning Net Package identifier when package-owned.

string
nullable
SourcePackageId

Owning package artifact identifier when package-owned.

string
nullable
SourceStableId

Stable source identifier when package-owned.

string
nullable
RowVersion

Optimistic concurrency token.

string format: uuid
Dependencies

Compiler-owned dependency summary.

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

Service Unavailable

Media typeapplication/json
object
Data

Field-owned Reference Eligibility configuration.

object
Id

Stable rule identifier.

string
nullable
EntityDefinitionId

Identifier of the source entity definition.

string
nullable
TargetFieldDefinitionId

Identifier of the dependent Reference field.

string
nullable
Expression

Eligibility expression authored against Current and Candidate.

string
nullable
Message

Optional default failure message.

string
nullable
MessageTranslations

Optional localized failure messages keyed by supported locale.

object
key
additional properties
string
Enabled

Whether the rule participates in runtime enforcement.

boolean
SchemaSource
integer format: int32
Allowed values: 0 1
SourceNetPackageId

Owning Net Package identifier when package-owned.

string
nullable
SourcePackageId

Owning package artifact identifier when package-owned.

string
nullable
SourceStableId

Stable source identifier when package-owned.

string
nullable
RowVersion

Optimistic concurrency token.

string format: uuid
Dependencies

Compiler-owned dependency summary.

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