Resolve one proposed Reference selection against a persisted Table filter draft.

POST

/api/workspace/entity/{entityIdOrKey}/ui/table/{tableSurfaceId}/filters/{filterItemKey}/reference-candidates/selection

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-candidates/selection"),
    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 } ] } } ] } }, \"SelectedId\": \"example\" }")
    {
        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-candidates/selection';
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}]}}]}},"SelectedId":"example"}'
};

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-candidates/selection \
  --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 } ] } } ] } }, "SelectedId": "example" }'

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

Anchored Table Surface request for one selected Reference value.

object

ExpectedTableSurfaceRowVersion

required

Exact saved Table Surface revision used by the caller.

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

SelectedId

required

Proposed target Entity Instance identifier.

string

Responses

200

application/json

object

Data

Safe selected-value resolution result.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10

ErrorCode

Stable guidance code when selection cannot proceed.

string

nullable

Item

Display-safe Reference candidate.

object

Candidate Entity Instance identifier.

string

nullable

DisplayName

Current candidate display name.

string

nullable

Subtitle

Optional current candidate subtitle.

string

nullable

IsArchived

Whether the candidate is archived.

boolean

Number

Current candidate number.

string

nullable

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

ProjectedValues

Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.

object

key

additional properties

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

400

Bad Request

application/json

object

Data

Safe selected-value resolution result.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10

ErrorCode

Stable guidance code when selection cannot proceed.

string

nullable

Item

Display-safe Reference candidate.

object

Candidate Entity Instance identifier.

string

nullable

DisplayName

Current candidate display name.

string

nullable

Subtitle

Optional current candidate subtitle.

string

nullable

IsArchived

Whether the candidate is archived.

boolean

Number

Current candidate number.

string

nullable

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

ProjectedValues

Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.

object

key

additional properties

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,
    "Item": {
      "SemanticPresentation": {
        "UsageType": 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

Safe selected-value resolution result.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10

ErrorCode

Stable guidance code when selection cannot proceed.

string

nullable

Item

Display-safe Reference candidate.

object

Candidate Entity Instance identifier.

string

nullable

DisplayName

Current candidate display name.

string

nullable

Subtitle

Optional current candidate subtitle.

string

nullable

IsArchived

Whether the candidate is archived.

boolean

Number

Current candidate number.

string

nullable

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

ProjectedValues

Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.

object

key

additional properties

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

409

Conflict

application/json

object

Data

Safe selected-value resolution result.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10

ErrorCode

Stable guidance code when selection cannot proceed.

string

nullable

Item

Display-safe Reference candidate.

object

Candidate Entity Instance identifier.

string

nullable

DisplayName

Current candidate display name.

string

nullable

Subtitle

Optional current candidate subtitle.

string

nullable

IsArchived

Whether the candidate is archived.

boolean

Number

Current candidate number.

string

nullable

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

ProjectedValues

Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.

object

key

additional properties

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

503

Service Unavailable

application/json

object

Data

Safe selected-value resolution result.

object

State

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10

ErrorCode

Stable guidance code when selection cannot proceed.

string

nullable

Item

Display-safe Reference candidate.

object

Candidate Entity Instance identifier.

string

nullable

DisplayName

Current candidate display name.

string

nullable

Subtitle

Optional current candidate subtitle.

string

nullable

IsArchived

Whether the candidate is archived.

boolean

Number

Current candidate number.

string

nullable

SemanticPresentation

Safe compact reference metadata, projected only for a resolved visible Entity reference.

object

UsageType

integer format: int32

Allowed values: 0 1 2

SemanticType

string

nullable

LinkRegistrationKey

string

nullable

CellRegistrationKey

string

nullable

ProjectedValues

Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.

object

key

additional properties

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

Resolve one proposed Reference selection against a persisted Table filter draft.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

503

Example

Example^generated