Return the saved hierarchy model and current Table-filter eligibility-context state.

POST

/api/workspace/entity/{entityIdOrKey}/ui/table/{tableSurfaceId}/filters/{filterItemKey}/reference-hierarchy/model

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/entity/example/ui/table/example/filters/example/reference-hierarchy/model"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"ExpectedTableSurfaceRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"DraftFilterTree\": { \"Root\": { \"Logic\": 0, \"Nodes\": [ { \"Group\": {}, \"Condition\": { \"FilterItemKey\": \"example\", \"Operator\": 0, \"Values\": [ { \"Kind\": 0, \"Value\": \"example\", \"Variable\": 0 } ] } } ] } } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/entity/example/ui/table/example/filters/example/reference-hierarchy/model';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"ExpectedTableSurfaceRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","DraftFilterTree":{"Root":{"Logic":0,"Nodes":[{"Group":{},"Condition":{"FilterItemKey":"example","Operator":0,"Values":[{"Kind":0,"Value":"example","Variable":0}]}}]}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

WorkspaceBearer

Parameters

Path Parameters

entityIdOrKey

required

string

tableSurfaceId

required

string

filterItemKey

required

string

Query Parameters

access_token

string

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

Request Body

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

Responses

200

application/json

object

Data

Hierarchy configuration response and current eligibility-context state.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Model

Server-derived hierarchy configuration for one saved Form field or Table filter.

object

ConfigurationRowVersion

Owning Form or Table Surface revision required by subsequent requests.

string format: uuid

SourceKind

integer format: int32

Allowed values: 0 1

TerminalFieldId

Bound terminal scalar Reference field identifier.

string

nullable

ExplicitPath

Fixed root-to-terminal hierarchy path.

object

LevelCount

Number of rendered levels, equal to Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.ReferencePath count plus one.

integer format: int32

Levels

Root-to-terminal level descriptors.

Array<object>

nullable

One rendered explicit hierarchy level.

object

LevelIndex

Zero-based root-to-terminal level index.

integer format: int32

EntityDefinitionId

Entity Definition represented by this level.

string

nullable

RelationFieldId

Reference field relating the next level to this level; null for the terminal level.

string

nullable

Label

Safe level label.

string

nullable

ReferencePath

Saved terminal-to-ancestor reference path used to derive Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.Levels.

Array<string>

nullable

RecursiveParent

Arbitrary-depth self-parent hierarchy descriptor.

object

EntityDefinitionId

Recursive target Entity Definition identifier.

string

nullable

ParentFieldId

Saved direct self-reference parent field identifier.

string

nullable

MaxResolvedChainDepth

Fixed maximum chain depth that one picker restore may materialize.

integer format: int32

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

400

Bad Request

application/json

object

Data

Hierarchy configuration response and current eligibility-context state.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Model

Server-derived hierarchy configuration for one saved Form field or Table filter.

object

ConfigurationRowVersion

Owning Form or Table Surface revision required by subsequent requests.

string format: uuid

SourceKind

integer format: int32

Allowed values: 0 1

TerminalFieldId

Bound terminal scalar Reference field identifier.

string

nullable

ExplicitPath

Fixed root-to-terminal hierarchy path.

object

LevelCount

Number of rendered levels, equal to Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.ReferencePath count plus one.

integer format: int32

Levels

Root-to-terminal level descriptors.

Array<object>

nullable

One rendered explicit hierarchy level.

object

LevelIndex

Zero-based root-to-terminal level index.

integer format: int32

EntityDefinitionId

Entity Definition represented by this level.

string

nullable

RelationFieldId

Reference field relating the next level to this level; null for the terminal level.

string

nullable

Label

Safe level label.

string

nullable

ReferencePath

Saved terminal-to-ancestor reference path used to derive Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.Levels.

Array<string>

nullable

RecursiveParent

Arbitrary-depth self-parent hierarchy descriptor.

object

EntityDefinitionId

Recursive target Entity Definition identifier.

string

nullable

ParentFieldId

Saved direct self-reference parent field identifier.

string

nullable

MaxResolvedChainDepth

Fixed maximum chain depth that one picker restore may materialize.

integer format: int32

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

403

Forbidden

application/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

application/json

object

Data

Hierarchy configuration response and current eligibility-context state.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Model

Server-derived hierarchy configuration for one saved Form field or Table filter.

object

ConfigurationRowVersion

Owning Form or Table Surface revision required by subsequent requests.

string format: uuid

SourceKind

integer format: int32

Allowed values: 0 1

TerminalFieldId

Bound terminal scalar Reference field identifier.

string

nullable

ExplicitPath

Fixed root-to-terminal hierarchy path.

object

LevelCount

Number of rendered levels, equal to Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.ReferencePath count plus one.

integer format: int32

Levels

Root-to-terminal level descriptors.

Array<object>

nullable

One rendered explicit hierarchy level.

object

LevelIndex

Zero-based root-to-terminal level index.

integer format: int32

EntityDefinitionId

Entity Definition represented by this level.

string

nullable

RelationFieldId

Reference field relating the next level to this level; null for the terminal level.

string

nullable

Label

Safe level label.

string

nullable

ReferencePath

Saved terminal-to-ancestor reference path used to derive Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.Levels.

Array<string>

nullable

RecursiveParent

Arbitrary-depth self-parent hierarchy descriptor.

object

EntityDefinitionId

Recursive target Entity Definition identifier.

string

nullable

ParentFieldId

Saved direct self-reference parent field identifier.

string

nullable

MaxResolvedChainDepth

Fixed maximum chain depth that one picker restore may materialize.

integer format: int32

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

409

Conflict

application/json

object

Data

Hierarchy configuration response and current eligibility-context state.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Model

Server-derived hierarchy configuration for one saved Form field or Table filter.

object

ConfigurationRowVersion

Owning Form or Table Surface revision required by subsequent requests.

string format: uuid

SourceKind

integer format: int32

Allowed values: 0 1

TerminalFieldId

Bound terminal scalar Reference field identifier.

string

nullable

ExplicitPath

Fixed root-to-terminal hierarchy path.

object

LevelCount

Number of rendered levels, equal to Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.ReferencePath count plus one.

integer format: int32

Levels

Root-to-terminal level descriptors.

Array<object>

nullable

One rendered explicit hierarchy level.

object

LevelIndex

Zero-based root-to-terminal level index.

integer format: int32

EntityDefinitionId

Entity Definition represented by this level.

string

nullable

RelationFieldId

Reference field relating the next level to this level; null for the terminal level.

string

nullable

Label

Safe level label.

string

nullable

ReferencePath

Saved terminal-to-ancestor reference path used to derive Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.Levels.

Array<string>

nullable

RecursiveParent

Arbitrary-depth self-parent hierarchy descriptor.

object

EntityDefinitionId

Recursive target Entity Definition identifier.

string

nullable

ParentFieldId

Saved direct self-reference parent field identifier.

string

nullable

MaxResolvedChainDepth

Fixed maximum chain depth that one picker restore may materialize.

integer format: int32

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

503

Service Unavailable

application/json

object

Data

Hierarchy configuration response and current eligibility-context state.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6

ErrorCode

Stable guidance code for a closed state.

string

nullable

Model

Server-derived hierarchy configuration for one saved Form field or Table filter.

object

ConfigurationRowVersion

Owning Form or Table Surface revision required by subsequent requests.

string format: uuid

SourceKind

integer format: int32

Allowed values: 0 1

TerminalFieldId

Bound terminal scalar Reference field identifier.

string

nullable

ExplicitPath

Fixed root-to-terminal hierarchy path.

object

LevelCount

Number of rendered levels, equal to Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.ReferencePath count plus one.

integer format: int32

Levels

Root-to-terminal level descriptors.

Array<object>

nullable

One rendered explicit hierarchy level.

object

LevelIndex

Zero-based root-to-terminal level index.

integer format: int32

EntityDefinitionId

Entity Definition represented by this level.

string

nullable

RelationFieldId

Reference field relating the next level to this level; null for the terminal level.

string

nullable

Label

Safe level label.

string

nullable

ReferencePath

Saved terminal-to-ancestor reference path used to derive Moltaro.Entity.ReferenceHierarchy.Models.EntityReferenceHierarchyExplicitPathModel.Levels.

Array<string>

nullable

RecursiveParent

Arbitrary-depth self-parent hierarchy descriptor.

object

EntityDefinitionId

Recursive target Entity Definition identifier.

string

nullable

ParentFieldId

Saved direct self-reference parent field identifier.

string

nullable

MaxResolvedChainDepth

Fixed maximum chain depth that one picker restore may materialize.

integer format: int32

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

Return the saved hierarchy model and current Table-filter eligibility-context state.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

503

Example

Example^generated