Skip to content

Return resolved selector dependencies connected to this entity definition's UI surfaces.

GET
/api/workspace/admin/entity-definitions/{entityDefinitionId}/ui/selector-dependencies
curl --request GET \
--url https://example.com/api/workspace/admin/entity-definitions/example/ui/selector-dependencies
  • 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

Resolved selector dependencies that enter or leave one entity definition’s UI surface catalog.

object
Dependencies

Persisted selector dependencies connected to the requested entity definition.

Array<object>
nullable

One persisted selector edge between a source surface and its resolved target surface.

object
SelectorId

Persisted selector row identifier.

string
nullable
SourceEntityDefinitionId

Entity definition that owns the source surface.

string
nullable
SourceSurfaceId

Persisted source surface identifier.

string
nullable
SourceSurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SourceSurfaceName

Source surface display name.

string
nullable
SourceSurfaceKey

Source surface key.

string
nullable
TargetEntityDefinitionId

Entity definition selected by the selector.

string
nullable
TargetSurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SelectorMode
integer format: int32
Allowed values: 0 1
RequestedSurfaceKey

Authored custom key, when the selector uses a custom key.

string
nullable
TargetMissing

Whether the selector currently resolves to no target surface.

boolean
TargetSurfaceId

Resolved target surface identifier, when available.

string
nullable
TargetSurfaceName

Resolved target surface display name, when available.

string
nullable
TargetSurfaceKey

Resolved target surface key, when available.

string
nullable
Slot
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9
Priority

Selector evaluation priority.

integer format: int32
RoleIds

Workspace roles scoped to this selector; empty means all roles.

Array<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": {
"Dependencies": [
{
"SourceSurfaceType": 0,
"TargetSurfaceType": 0,
"SelectorMode": 0,
"Slot": 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

Resolved selector dependencies that enter or leave one entity definition’s UI surface catalog.

object
Dependencies

Persisted selector dependencies connected to the requested entity definition.

Array<object>
nullable

One persisted selector edge between a source surface and its resolved target surface.

object
SelectorId

Persisted selector row identifier.

string
nullable
SourceEntityDefinitionId

Entity definition that owns the source surface.

string
nullable
SourceSurfaceId

Persisted source surface identifier.

string
nullable
SourceSurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SourceSurfaceName

Source surface display name.

string
nullable
SourceSurfaceKey

Source surface key.

string
nullable
TargetEntityDefinitionId

Entity definition selected by the selector.

string
nullable
TargetSurfaceType
integer format: int32
Allowed values: 0 1 2 3 4 5
SelectorMode
integer format: int32
Allowed values: 0 1
RequestedSurfaceKey

Authored custom key, when the selector uses a custom key.

string
nullable
TargetMissing

Whether the selector currently resolves to no target surface.

boolean
TargetSurfaceId

Resolved target surface identifier, when available.

string
nullable
TargetSurfaceName

Resolved target surface display name, when available.

string
nullable
TargetSurfaceKey

Resolved target surface key, when available.

string
nullable
Slot
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9
Priority

Selector evaluation priority.

integer format: int32
RoleIds

Workspace roles scoped to this selector; empty means all roles.

Array<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": {
"Dependencies": [
{
"SourceSurfaceType": 0,
"TargetSurfaceType": 0,
"SelectorMode": 0,
"Slot": 0
}
]
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}