Return query options.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/entity/example/instances/query/options"),};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/instances/query/options';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/entity/example/instances/query/optionsReturns backend-approved filter and sort options for one runtime entity definition. The payload is security-shaped for the current caller and includes only query targets that the backend would actually accept for filtering, sorting, and child-table row predicates.
Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entity definition identifier or normalized entity key.
Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Backend-approved query capabilities for one runtime entity definition.
object
Ordered list of query targets available to the current caller.
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Maximum number of accepted sort items.
object
object
object
object
Example
{ "Data": { "Options": [ { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Backend-approved query capabilities for one runtime entity definition.
object
Ordered list of query targets available to the current caller.
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Maximum number of accepted sort items.
object
object
object
object
Example
{ "Data": { "Options": [ { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Backend-approved query capabilities for one runtime entity definition.
object
Ordered list of query targets available to the current caller.
One runtime query target with backend-approved filter and sort capabilities.
object
Stable option identifier.
Localized user-facing label.
Reference to a runtime field by identifier, normalized key, or special query field.
object
Field identifier or backend-issued synthetic system-field identifier.
Field key resolved through the runtime normalized-key index.
Statement identifier resolved through the runtime statement index.
Statement key resolved through the runtime normalized-key index.
Configured object-context fact identifier.
Provider-owned object-context fact filter facet key.
Whether multiple values are allowed for the bound field.
Decimal precision when applicable.
Decimal scale when applicable.
String max length when applicable.
Target entity definition identifier for reference-style fields.
Paired reference field identifier for inverse-reference fields.
Select options when applicable.
Option metadata for select fields.
object
Option identifier.
Owning field identifier.
Option key.
Option display value.
Sort order.
Whether the backend accepts filter predicates for this option.
Operators accepted by the backend for this option.
Runtime variables accepted by the backend for this option.
Whether the backend accepts sort items for this option.
Base currency code for Money fields.
Maximum number of accepted sort items.
object
object
object
object
Example
{ "Data": { "Options": [ { "Kind": 0, "Reference": { "Special": 0 }, "FieldType": 0, "ReferenceDeleteBehavior": 0, "FilterOperators": [ 0 ], "FilterVariables": [ 0 ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}