Skip to content
MoltaroMoltaroMoltaro Docs

Return one recursive hierarchy root page for a saved Table Reference filter.

POST
/api/workspace/entity/{entityIdOrKey}/ui/table/{tableSurfaceId}/filters/{filterItemKey}/reference-hierarchy/recursive/roots
curl --request POST \
  --url https://example.com/api/workspace/entity/example/ui/table/example/filters/example/reference-hierarchy/recursive/roots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Context": { "ExpectedTableSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "DraftFilterTree": { "Root": { "Logic": 0, "Nodes": [ { "Group": {}, "Condition": { "FilterItemKey": "example", "Operator": 0, "Values": [ { "Kind": 0, "Value": "example", "Variable": 0 } ] } } ] } } }, "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

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
entityIdOrKey
required
string
tableSurfaceId
required
string
filterItemKey
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Request Body

Section titled “Request Body”

Table hierarchy page request.

object
Context
required

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

object
ExpectedTableSurfaceRowVersion
required

Exact owning Table Surface revision.

string format: uuid
DraftFilterTree
required

Non-executable draft filter tree used only to derive Reference Eligibility context for a persisted Table Surface filter item.

object
Root
required

One group in a non-executable Table filter draft.

object
Logic
required
integer format: int32
Allowed values: 0 1
Nodes
required

Nested groups and conditions.

Array<object>

One node in a non-executable Table filter draft. Exactly one of Moltaro.Entity.ReferenceEligibility.Requests.EntityTableReferenceDraftFilterNodeRequest.Group and Moltaro.Entity.ReferenceEligibility.Requests.EntityTableReferenceDraftFilterNodeRequest.Condition must be supplied.

object
Group
object recursive
Condition

One condition in a non-executable Table filter draft.

object
FilterItemKey
required

Canonical key of the persisted Table Surface filter item.

string
Operator
required
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
Values

Typed draft operands. The routed dependent may have no value while its picker is open.

Array<object>
nullable

One typed operand in a non-executable Table filter draft. Its JSON shape mirrors the ordinary query operand while retaining an independent strict unknown-property boundary.

object
Kind
required
integer format: int32
Allowed values: 0 1
Value

Literal JSON value for Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value.

nullable
Variable
integer format: int32
Allowed values: 0 1
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

Section titled “Responses”

200

Section titled “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

Section titled “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

Section titled “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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “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

Section titled “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

Section titled “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
    }
  ]
}