Return one explicit hierarchy level for a saved Form Reference field.

POST

/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/reference-hierarchy/explicit/levels/{levelIndex}

curl --request POST \
  --url https://example.com/api/workspace/entity/example/ui/form/example/items/example/reference-hierarchy/explicit/levels/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Context": { "ExpectedFormSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "SourceInstanceId": "example", "CurrentValues": { "additionalProperty": "example" }, "ParentContext": { "EntityDefinitionId": "example", "FormSurfaceId": "example", "ExpectedRevision": "example", "ItemId": "example", "ParentInstanceId": "example", "ParentFields": { "additionalProperty": "example" } } }, "Query": { "SelectedAncestorIds": [ "example" ], "ParentId": "example", "Search": "example", "Page": 1, "PageSize": 1, "Sort": [ { "Field": { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" }, "Target": { "Path": [ { "FieldId": "example", "FieldKey": "example", "Special": 0, "StatementId": "example", "StatementKey": "example", "ObjectContextFactId": "example", "ObjectContextFactFilterKey": "example" } ] }, "Direction": 0 } ] } }'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

formSurfaceId

required

string

formItemId

required

string

levelIndex

required

integer format: int32

Query Parameters

access_token

string

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

Request Body

Form hierarchy page request.

object

Context

required

Saved Form context used by hierarchy model, page, and selection routes.

object

ExpectedFormSurfaceRowVersion

required

Exact owning Form Surface revision.

string format: uuid

SourceInstanceId

Existing source record identifier for edit, or null for create.

string

nullable

CurrentValues

Dynamic Form draft values keyed by the server-declared source field keys. Reference values are raw Entity Instance identifier strings, not value wrappers.

object

key

additional properties

A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.

nullable

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

Query

required

Search, sorting, paging, and relationship context for one hierarchy level.

object

SelectedAncestorIds

Explicit-path ancestors in rendered root-to-parent order.

Array<string>

nullable

ParentId

Recursive parent identifier for a direct-child request.

string

nullable

Search

Optional configured Entity search term.

string

nullable

Page

One-based requested page.

integer format: int32

PageSize

Requested page size. The effective maximum is 250.

integer format: int32

Sort

Optional current-level sort sequence of at most three items.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Form hierarchy page request.

object

Context

required

Saved Form context used by hierarchy model, page, and selection routes.

object

ExpectedFormSurfaceRowVersion

required

Exact owning Form Surface revision.

string format: uuid

SourceInstanceId

Existing source record identifier for edit, or null for create.

string

nullable

CurrentValues

Dynamic Form draft values keyed by the server-declared source field keys. Reference values are raw Entity Instance identifier strings, not value wrappers.

object

key

additional properties

A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.

nullable

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

Query

required

Search, sorting, paging, and relationship context for one hierarchy level.

object

SelectedAncestorIds

Explicit-path ancestors in rendered root-to-parent order.

Array<string>

nullable

ParentId

Recursive parent identifier for a direct-child request.

string

nullable

Search

Optional configured Entity search term.

string

nullable

Page

One-based requested page.

integer format: int32

PageSize

Requested page size. The effective maximum is 250.

integer format: int32

Sort

Optional current-level sort sequence of at most three items.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Form hierarchy page request.

object

Context

required

Saved Form context used by hierarchy model, page, and selection routes.

object

ExpectedFormSurfaceRowVersion

required

Exact owning Form Surface revision.

string format: uuid

SourceInstanceId

Existing source record identifier for edit, or null for create.

string

nullable

CurrentValues

Dynamic Form draft values keyed by the server-declared source field keys. Reference values are raw Entity Instance identifier strings, not value wrappers.

object

key

additional properties

A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.

nullable

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

Query

required

Search, sorting, paging, and relationship context for one hierarchy level.

object

SelectedAncestorIds

Explicit-path ancestors in rendered root-to-parent order.

Array<string>

nullable

ParentId

Recursive parent identifier for a direct-child request.

string

nullable

Search

Optional configured Entity search term.

string

nullable

Page

One-based requested page.

integer format: int32

PageSize

Requested page size. The effective maximum is 250.

integer format: int32

Sort

Optional current-level sort sequence of at most three items.

Array<object>

nullable

One sort item in the runtime list query.

object

Field

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Target

Typed server-side sort target. The first segment belongs to the queried entity; every intermediate segment must be a readable, sortable primary-table reference.

object

Path

Ordered path of one to four segments ending in a sortable field or system field. Each segment may contain an ID, a key, or both; an ID/key mismatch is rejected.

Array<object>

nullable

Reference to a runtime field by identifier, normalized key, or special query field. In a typed path the segment is resolved against the entity reached by the preceding reference.

object

FieldId

Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.

string

nullable

FieldKey

Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.

string

nullable

Special

integer format: int32

Allowed values: 0 1

StatementId

Statement identifier resolved through the runtime statement index.

string

nullable

StatementKey

Statement key resolved through the runtime normalized-key index.

string

nullable

ObjectContextFactId

Configured object-context fact identifier.

string

nullable

ObjectContextFactFilterKey

Provider-owned object-context fact filter facet key.

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Responses

200

OK

Media typeapplication/json

object

Data

One paged hierarchy level.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Items

Display-safe options. Empty for every non-ready state.

Array<object>

nullable

One display-safe hierarchy option.

object

Id

Entity Instance identifier.

string

nullable

DisplayName

Current display name.

string

nullable

Subtitle

Optional current subtitle.

string

nullable

HasChildren

Whether at least one readable structural child exists.

boolean

CanConfirm

Whether the option may be returned as the terminal Reference value.

boolean

ConfirmationState

integer format: int32

Allowed values: 0 1 2

ConfirmationMessage

Optional safe localized explanation for a non-confirmable state.

string

nullable

Page

One-based effective page.

integer format: int32

PageSize

Effective bounded page size.

integer format: int32

TotalCount

Accessible post-policy total count for a ready response only.

integer format: int32

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

400

Bad Request

Media typeapplication/json

object

Data

One paged hierarchy level.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Items

Display-safe options. Empty for every non-ready state.

Array<object>

nullable

One display-safe hierarchy option.

object

Id

Entity Instance identifier.

string

nullable

DisplayName

Current display name.

string

nullable

Subtitle

Optional current subtitle.

string

nullable

HasChildren

Whether at least one readable structural child exists.

boolean

CanConfirm

Whether the option may be returned as the terminal Reference value.

boolean

ConfirmationState

integer format: int32

Allowed values: 0 1 2

ConfirmationMessage

Optional safe localized explanation for a non-confirmable state.

string

nullable

Page

One-based effective page.

integer format: int32

PageSize

Effective bounded page size.

integer format: int32

TotalCount

Accessible post-policy total count for a ready response only.

integer format: int32

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

403

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

One paged hierarchy level.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Items

Display-safe options. Empty for every non-ready state.

Array<object>

nullable

One display-safe hierarchy option.

object

Id

Entity Instance identifier.

string

nullable

DisplayName

Current display name.

string

nullable

Subtitle

Optional current subtitle.

string

nullable

HasChildren

Whether at least one readable structural child exists.

boolean

CanConfirm

Whether the option may be returned as the terminal Reference value.

boolean

ConfirmationState

integer format: int32

Allowed values: 0 1 2

ConfirmationMessage

Optional safe localized explanation for a non-confirmable state.

string

nullable

Page

One-based effective page.

integer format: int32

PageSize

Effective bounded page size.

integer format: int32

TotalCount

Accessible post-policy total count for a ready response only.

integer format: int32

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

409

Conflict

Media typeapplication/json

object

Data

One paged hierarchy level.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Items

Display-safe options. Empty for every non-ready state.

Array<object>

nullable

One display-safe hierarchy option.

object

Id

Entity Instance identifier.

string

nullable

DisplayName

Current display name.

string

nullable

Subtitle

Optional current subtitle.

string

nullable

HasChildren

Whether at least one readable structural child exists.

boolean

CanConfirm

Whether the option may be returned as the terminal Reference value.

boolean

ConfirmationState

integer format: int32

Allowed values: 0 1 2

ConfirmationMessage

Optional safe localized explanation for a non-confirmable state.

string

nullable

Page

One-based effective page.

integer format: int32

PageSize

Effective bounded page size.

integer format: int32

TotalCount

Accessible post-policy total count for a ready response only.

integer format: int32

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

503

Service Unavailable

Media typeapplication/json

object

Data

One paged hierarchy level.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Items

Display-safe options. Empty for every non-ready state.

Array<object>

nullable

One display-safe hierarchy option.

object

Id

Entity Instance identifier.

string

nullable

DisplayName

Current display name.

string

nullable

Subtitle

Optional current subtitle.

string

nullable

HasChildren

Whether at least one readable structural child exists.

boolean

CanConfirm

Whether the option may be returned as the terminal Reference value.

boolean

ConfirmationState

integer format: int32

Allowed values: 0 1 2

ConfirmationMessage

Optional safe localized explanation for a non-confirmable state.

string

nullable

Page

One-based effective page.

integer format: int32

PageSize

Effective bounded page size.

integer format: int32

TotalCount

Accessible post-policy total count for a ready response only.

integer format: int32

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