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

Syntax

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

Parameters

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.

You can refine the function's output by using dot notation (.) to access specific fields. To have the expression return just the queried data, add .data to the end of the a!queryRecordType() function. Then, to access the data contained in a particular field, add the field name with a record field reference: data[recordType!<record type name>.fields.<field name>]

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.

Notes

• Service-backed and Salesforce-backed record types without data sync enabled 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 upgrading 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!Customer,
  selection: {
    recordType!Customer.fields.Name,
    recordType!Customer.fields.LogoID,
    recordType!Customer.fields.Industry
  },
  filters: {
    a!queryFilter(
      field: recordType!Customer.fields.InactiveFlag,
      operator: "=",
      value: false
    )
  },
  pagingInfo: a!pagingInfo(
    startIndex: 1,
    batchSize: 5000,
    sort: {
      a!sortInfo(
        field: recordType!Customer.fields.UpdatedOn,
        ascending: false
      ),
      a!sortInfo(
        field: recordType!Customer.fields.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.