a!queryRecordType() Function

This function executes a query on a given record type and returns the result.

Syntax

a!queryRecordType(recordType, selection, filters, pagingInfo, fetchTotalCount)

Parameters

Keyword Type Description

recordType

RecordType

A reference to a record type. You must reference the record type directly from the recordType! domain. For example, recordType!Case.

selection

Any Type

List of record fields to be retrieved from the query. Record fields must be directly referenced from the recordType! domain. For example: recordType!Case.fields.caseName. When no record fields are specified, all record fields are returned in the order they are configured in the record type's data model.

filters

Any Type

A single, logical expression or a list of query filters can be provided to filter the results. Without a logical expression, a list of query filters will only return those records where all filters evaluate to true (AND comparisons). Queries also apply the default filters defined on the referenced record type.

pagingInfo

PagingInfo

The paging and sorting configurations to apply when retrieving the record data.

fetchTotalCount

Boolean

If set to true, runs a separate query that retrieves the total number of records in the totalCount parameter of the query result. In cases where you don't need the totalCount, skipping this additional query can improve performance. Can only be used with record types that source from a data store entity.

Returns

The return type of a!queryRecordType will be a Map data type with the following parameters:

  • success (Boolean)
  • data (List of Record Maps)
  • startIndex (Integer)
  • batchSize (Integer)
  • sort (List of SortInfo)
  • totalCount (Integer)
  • identifiers (List of Integer or List of Text)
  • errorCode (Text)

This map will have the same named fields as a DataSubset (so that it can seamlessly be cast to that type when being passed around your application) with the addition of "success" and "errorCode" fields, like results from an Integration object, so app developers can build error-handling into their applications.

Error Codes

a!queryRecordType returns a query result even if a runtime error happened. In these cases the "success" field of the result would have a value of false and the "errorCode" field will return an Appian Error Code indicating what has happened. You can use these codes to decide what to do next in your application.

Error Code Description Usage
APNX-1-4205-038 The user does not have access to the this record type or the underlying data source. This error code could be used to hide elements of an interface.
APNX-1-4205-039 This is a record type with sync enabled, and is currently unavailable due to a sync issue. This error code could be used as a condition on which to query the data source instead of waiting for the sync issue to be resolved.
APNX-1-4205-040 The record type's data source could not be reached, or the query limit for that source has been reached. While uncommon, for finicky data sources, this error code could be used to prevent an interface from breaking.

Notes

  • Expression-backed record types are not supported.
  • The batchSize in your pagingInfo for a!queryRecordType cannot be larger than 5000, and cannot be -1.
  • If you don't specify a selection of fields, all fields are returned.
  • Multiple sortInfos is not yet available for process-backed record types.
  • If the record type isn't sorted by the identifier, a final identifier sort is added to ensure deterministic sorting.
  • The data in the query returned is a list of records, not dictionary.
  • This query does not yet support aggregation.
  • You must update the target record type after upgrade to 20.3 in order to use this query.

Example

NOTE: This uses the record type "Customer" for the purpose of illustration only. If you copy and paste the expression below into the Expression Rule Interface, it will not evaluate in your Test Rules interface. Use it as a reference only.

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
a!queryRecordType(
  recordType: 'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer',
  selection: {
    'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer.fields.{Name}Name',
    'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer.fields.{LogoID}LogoID',
    'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer.fields.{Industry}Industry'
  },
  filters: {
    a!queryFilter(
      field: 'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer.fields.{InactiveFlag}InactiveFlag',
      operator: "=",
      value: false
    )
  },
  pagingInfo: a!pagingInfo(
    startIndex: 1,
    batchSize: 5000,
    sort: {
      a!sortInfo(
        field: 'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer.fields.{UpdatedOn}UpdatedOn',
        ascending: false
      ),
      a!sortInfo(
        field: 'recordType!{7db9a56b-b303-46e1-81c9-c11dfffab8d8}Customer.fields.{Name}Name',
        ascending: true
      )
    }
  ),
  fetchTotalCount: true
)

See Also

  • Record Type: Additional information on the data type accepted for the recordType value.
  • Query: Additional information on the data type accepted for the query value and how to create a type constructor for it including which fields are required/optional.
  • Query Recipes - A list of examples of how to use the Query object to meet common use cases.
  • DataSubset: Additional information on the structure of this data type.
  • Constructing Data Type Values: Additional information on creating the query value via a type constructor.
  • a! queryAggregationColumn() Function: Additional information on grouping Date and Date and Time fields by year and month.
Open in Github

On This Page

FEEDBACK