Return one secure page of eligible Reference candidates for a persisted Form item.
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/form/example/items/example/reference-candidates/query"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"ExpectedFormSurfaceRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"SourceInstanceId\": \"example\", \"CurrentValues\": { \"additionalProperty\": \"example\" }, \"Query\": { \"Search\": \"example\", \"Filter\": { \"Operator\": 0, \"Conditions\": [ { \"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\" } ] }, \"Operator\": 0, \"Values\": [ { \"Kind\": 0, \"Value\": \"example\", \"Variable\": 0 } ], \"RowsFilter\": {}, \"Spatial\": { \"ShapeKind\": 0, \"Center\": { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" }, \"RadiusKm\": 1, \"BoundingBox\": { \"SouthWest\": { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" }, \"NorthEast\": { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" } }, \"Polygon\": [ { \"Latitude\": 1, \"Longitude\": 1, \"FullAddress\": \"example\" } ] } } ], \"Groups\": [] }, \"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 } ], \"Page\": 1, \"PageSize\": 25 }, \"ParentContext\": { \"EntityDefinitionId\": \"example\", \"FormSurfaceId\": \"example\", \"ExpectedRevision\": \"example\", \"ItemId\": \"example\", \"ParentInstanceId\": \"example\", \"ParentFields\": { \"additionalProperty\": \"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/form/example/items/example/reference-candidates/query';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"ExpectedFormSurfaceRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","SourceInstanceId":"example","CurrentValues":{"additionalProperty":"example"},"Query":{"Search":"example","Filter":{"Operator":0,"Conditions":[{"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"}]},"Operator":0,"Values":[{"Kind":0,"Value":"example","Variable":0}],"RowsFilter":{},"Spatial":{"ShapeKind":0,"Center":{"Latitude":1,"Longitude":1,"FullAddress":"example"},"RadiusKm":1,"BoundingBox":{"SouthWest":{"Latitude":1,"Longitude":1,"FullAddress":"example"},"NorthEast":{"Latitude":1,"Longitude":1,"FullAddress":"example"}},"Polygon":[{"Latitude":1,"Longitude":1,"FullAddress":"example"}]}}],"Groups":[]},"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}],"Page":1,"PageSize":25},"ParentContext":{"EntityDefinitionId":"example","FormSurfaceId":"example","ExpectedRevision":"example","ItemId":"example","ParentInstanceId":"example","ParentFields":{"additionalProperty":"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/form/example/items/example/reference-candidates/query \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "ExpectedFormSurfaceRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "SourceInstanceId": "example", "CurrentValues": { "additionalProperty": "example" }, "Query": { "Search": "example", "Filter": { "Operator": 0, "Conditions": [ { "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" } ] }, "Operator": 0, "Values": [ { "Kind": 0, "Value": "example", "Variable": 0 } ], "RowsFilter": {}, "Spatial": { "ShapeKind": 0, "Center": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" }, "RadiusKm": 1, "BoundingBox": { "SouthWest": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" }, "NorthEast": { "Latitude": 1, "Longitude": 1, "FullAddress": "example" } }, "Polygon": [ { "Latitude": 1, "Longitude": 1, "FullAddress": "example" } ] } } ], "Groups": [] }, "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 } ], "Page": 1, "PageSize": 25 }, "ParentContext": { "EntityDefinitionId": "example", "FormSurfaceId": "example", "ExpectedRevision": "example", "ItemId": "example", "ParentInstanceId": "example", "ParentFields": { "additionalProperty": "example" } } }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Anchored Form request for eligible Reference candidates.
object
Exact saved Form Surface revision used by the caller.
Existing source identifier for edit, or null for create.
Dynamic Form draft values keyed by the server-declared source field keys. Reference values are raw Entity Instance identifier strings, not value wrappers.
object
A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.
Search, filter, sort, and paging applied to eligible Reference candidates.
object
Optional configured Entity search term. Blank input adds no search. Ordinary substring search uses 3–256 trimmed characters and configured SearchTargets; exact #number and #{id} shortcuts are also supported. Search is ANDed with Filter and eligibility. A nonblank search without configured targets is rejected.
One nested logical filter group.
object
Direct conditions inside this group.
One leaf condition in the runtime list query tree.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
Typed server-side condition target. The first segment belongs to the queried entity; every intermediate segment must be a readable primary-table reference, and the terminal segment determines the field type, supported operators, and operand shape.
object
Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
Operand list for the selected operator.
One query operand.
object
Literal JSON value used when Moltaro.Entity.Instances.Requests.EntityInstanceQueryOperandRequest.Kind is Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value. Select and enum fields accept the string option key; numeric enum ordinals and display labels are not operands.
Spatial operand for address-style runtime query conditions.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Radius in kilometers for radius-based queries.
Reserved WGS84 bounding box for future spatial queries.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Reserved polygon payload for future spatial queries.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Optional ordinary target-Entity sort sequence.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
One-based requested page, at least 1. Defaults to 1 when omitted.
Requested page size from 1 through 250. Defaults to 25 when omitted. Invalid sizes are rejected, not clamped; use Page, PageSize, and TotalCount to retrieve subsequent pages of a Ready result.
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
Id of the parent Entity definition.
Id of the parent Form surface.
The Submission.Revision of the parent Form the client renders.
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).
Id of the existing parent record; null while the parent is created by the same Form.
Unsaved parent draft values by field key, as the parent Form evaluation takes them.
object
Anchored Form request for eligible Reference candidates.
object
Exact saved Form Surface revision used by the caller.
Existing source identifier for edit, or null for create.
Dynamic Form draft values keyed by the server-declared source field keys. Reference values are raw Entity Instance identifier strings, not value wrappers.
object
A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.
Search, filter, sort, and paging applied to eligible Reference candidates.
object
Optional configured Entity search term. Blank input adds no search. Ordinary substring search uses 3–256 trimmed characters and configured SearchTargets; exact #number and #{id} shortcuts are also supported. Search is ANDed with Filter and eligibility. A nonblank search without configured targets is rejected.
One nested logical filter group.
object
Direct conditions inside this group.
One leaf condition in the runtime list query tree.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
Typed server-side condition target. The first segment belongs to the queried entity; every intermediate segment must be a readable primary-table reference, and the terminal segment determines the field type, supported operators, and operand shape.
object
Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
Operand list for the selected operator.
One query operand.
object
Literal JSON value used when Moltaro.Entity.Instances.Requests.EntityInstanceQueryOperandRequest.Kind is Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value. Select and enum fields accept the string option key; numeric enum ordinals and display labels are not operands.
Spatial operand for address-style runtime query conditions.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Radius in kilometers for radius-based queries.
Reserved WGS84 bounding box for future spatial queries.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Reserved polygon payload for future spatial queries.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Optional ordinary target-Entity sort sequence.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
One-based requested page, at least 1. Defaults to 1 when omitted.
Requested page size from 1 through 250. Defaults to 25 when omitted. Invalid sizes are rejected, not clamped; use Page, PageSize, and TotalCount to retrieve subsequent pages of a Ready result.
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
Id of the parent Entity definition.
Id of the parent Form surface.
The Submission.Revision of the parent Form the client renders.
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).
Id of the existing parent record; null while the parent is created by the same Form.
Unsaved parent draft values by field key, as the parent Form evaluation takes them.
object
Anchored Form request for eligible Reference candidates.
object
Exact saved Form Surface revision used by the caller.
Existing source identifier for edit, or null for create.
Dynamic Form draft values keyed by the server-declared source field keys. Reference values are raw Entity Instance identifier strings, not value wrappers.
object
A typed scalar or complex field value. Reference fields use the raw Entity Instance identifier string.
Search, filter, sort, and paging applied to eligible Reference candidates.
object
Optional configured Entity search term. Blank input adds no search. Ordinary substring search uses 3–256 trimmed characters and configured SearchTargets; exact #number and #{id} shortcuts are also supported. Search is ANDed with Filter and eligibility. A nonblank search without configured targets is rejected.
One nested logical filter group.
object
Direct conditions inside this group.
One leaf condition in the runtime list query tree.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
Typed server-side condition target. The first segment belongs to the queried entity; every intermediate segment must be a readable primary-table reference, and the terminal segment determines the field type, supported operators, and operand shape.
object
Ordered path of one to six segments. Each segment may contain an ID, a key, or both; when both are supplied they must resolve to the same field in the entity reached by the preceding segment.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
Operand list for the selected operator.
One query operand.
object
Literal JSON value used when Moltaro.Entity.Instances.Requests.EntityInstanceQueryOperandRequest.Kind is Moltaro.Enums.EntityInstanceQueryOperandKindEnum.Value. Select and enum fields accept the string option key; numeric enum ordinals and display labels are not operands.
Spatial operand for address-style runtime query conditions.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Radius in kilometers for radius-based queries.
Reserved WGS84 bounding box for future spatial queries.
object
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Reserved polygon payload for future spatial queries.
Geographic point in WGS84 coordinates.
object
Latitude in decimal degrees.
Longitude in decimal degrees.
Optional display address selected by the user.
Optional ordinary target-Entity sort sequence.
One sort item in the runtime list query.
object
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
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
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.
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
Field identifier or backend-issued synthetic system-field identifier. If FieldKey is also supplied, both must resolve to the same field.
Field key resolved through the current entity’s normalized-key index. If FieldId is also supplied, both must resolve to the same field.
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.
One-based requested page, at least 1. Defaults to 1 when omitted.
Requested page size from 1 through 250. Defaults to 25 when omitted. Invalid sizes are rejected, not clamped; use Page, PageSize, and TotalCount to retrieve subsequent pages of a Ready result.
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
Id of the parent Entity definition.
Id of the parent Form surface.
The Submission.Revision of the parent Form the client renders.
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).
Id of the existing parent record; null while the parent is created by the same Form.
Unsaved parent draft values by field key, as the parent Form evaluation takes them.
object
Responses
Section titled “Responses”OK
object
Paged eligible Reference candidates and their context readiness.
object
Stable guidance code for a non-ready state.
Display-safe candidates. Empty for every non-ready state.
Display-safe Reference candidate.
object
Candidate Entity Instance identifier.
Current candidate display name.
Optional current candidate subtitle.
Whether the candidate is archived.
Current candidate number.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.
object
One-based effective page.
Effective bounded page size.
Accessible post-policy candidate count, or null for a non-ready state.
Whether the actor may create a target record in this ready governed context.
object
object
object
object
Example
{ "Data": { "State": 0, "Items": [ { "SemanticPresentation": { "UsageType": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Paged eligible Reference candidates and their context readiness.
object
Stable guidance code for a non-ready state.
Display-safe candidates. Empty for every non-ready state.
Display-safe Reference candidate.
object
Candidate Entity Instance identifier.
Current candidate display name.
Optional current candidate subtitle.
Whether the candidate is archived.
Current candidate number.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.
object
One-based effective page.
Effective bounded page size.
Accessible post-policy candidate count, or null for a non-ready state.
Whether the actor may create a target record in this ready governed context.
object
object
object
object
Example
{ "Data": { "State": 0, "Items": [ { "SemanticPresentation": { "UsageType": 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
Paged eligible Reference candidates and their context readiness.
object
Stable guidance code for a non-ready state.
Display-safe candidates. Empty for every non-ready state.
Display-safe Reference candidate.
object
Candidate Entity Instance identifier.
Current candidate display name.
Optional current candidate subtitle.
Whether the candidate is archived.
Current candidate number.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.
object
One-based effective page.
Effective bounded page size.
Accessible post-policy candidate count, or null for a non-ready state.
Whether the actor may create a target record in this ready governed context.
object
object
object
object
Example
{ "Data": { "State": 0, "Items": [ { "SemanticPresentation": { "UsageType": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Paged eligible Reference candidates and their context readiness.
object
Stable guidance code for a non-ready state.
Display-safe candidates. Empty for every non-ready state.
Display-safe Reference candidate.
object
Candidate Entity Instance identifier.
Current candidate display name.
Optional current candidate subtitle.
Whether the candidate is archived.
Current candidate number.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.
object
One-based effective page.
Effective bounded page size.
Accessible post-policy candidate count, or null for a non-ready state.
Whether the actor may create a target record in this ready governed context.
object
object
object
object
Example
{ "Data": { "State": 0, "Items": [ { "SemanticPresentation": { "UsageType": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Service Unavailable
object
Paged eligible Reference candidates and their context readiness.
object
Stable guidance code for a non-ready state.
Display-safe candidates. Empty for every non-ready state.
Display-safe Reference candidate.
object
Candidate Entity Instance identifier.
Current candidate display name.
Optional current candidate subtitle.
Whether the candidate is archived.
Current candidate number.
Safe compact reference metadata, projected only for a resolved visible Entity reference.
object
Access-shaped target scalar and Money values keyed by target field key. Money values contain Amount and CurrencyCode.
object
One-based effective page.
Effective bounded page size.
Accessible post-policy candidate count, or null for a non-ready state.
Whether the actor may create a target record in this ready governed context.
object
object
object
object
Example
{ "Data": { "State": 0, "Items": [ { "SemanticPresentation": { "UsageType": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}