Free cookie consent management tool by TermsFeed a!query() Function
a!query() Function

Function

a!query( selection, aggregation, logicalExpression, filter, pagingInfo )

Creates a Query object for use in the a!queryEntity() function.

See also: Aggregation, Selection, logicalexpression, paginginfo, query, queryfilter

Parameters

Keyword Type Description

selection

Selection

A list of fields that you wish to retrieve, created with a!querySelection().

aggregation

Aggregation

A list of fields and the operations you wish to perform on them when retrieving the data, created with a!queryAggregation().

logicalExpression

LogicalExpression

A set of conditions to apply to the queried data before any grouping or aggregation, created with a!queryLogicalExpression().

filter

QueryFilter

A single condition to apply to the queried data before any grouping or aggregation, created with a!queryFilter().

pagingInfo

PagingInfo

The paging and sorting configurations to apply when retrieving the data, created with a!pagingInfo().

Returns

Query

Usage considerations

Required parameter

  • The pagingInfo parameter is required.

Optional parameters

  • You may specify either the selection parameter or the aggregation parameter but not both. If you do not specify either parameter, all fields are returned.

  • You may specify either the logicalExpression parameter or the filter parameter but not both. If you wish to specify only one condition, use filter. If you wish to specify more than one condition, use logicalExpression.

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Partially compatible

Can be used with Appian Portals if it is connected using an integration and web API.

Offline Mobile Partially compatible

Can be used with offline mobile if it is loaded at the top of the form.

Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

Open in Github Built: Fri, Mar 15, 2024 (05:31:14 PM)

a!query() Function

FEEDBACK