Query List

Add action

Use context menu or action toolbox to add Query List action to workflow scheme.

  • Click on the area with (Edit) icon on the scheme and:
  • Select category Lists and items;
  • Choose Query List.
  • In action toolbox:
  • Select category Lists and items;
  • Drag and drop Query List action to the area with (Edit) icon on the workflow scheme.

Configure action

Open action configuration dialog to edit action properties:

  • Open action context menu on the scheme and choose Edit;
  • Or double click the action on the scheme.

Action properties

Use configuration dialog to edit action properties:

Property Description
List List or document library to which query will be applied.
Filter Expression to filter items.
There are two options to build filter expression:

  • Query builder;
  • OData filter editor.

There two ways to select items available for Query builder:

  • Select all list items;
  • Select items only when the following is true.

Filter expression for OData filter editor is a string in OData format.
Lookups are available for this property.

Sort Order in which selected items will be returned.
Allows to set sequence of the sort rules.
Maximum number of rows Maximum number of items which will be returned as result of the query.
Output type Format of the returned value.
There are options:

  • Single output;
  • Separate output per column.

Choose Single output to store query result in a single variable specified in Output property.
Choose Separate output per column to store each returned column in variable specified in Output property.

Column to select Columns which will be returned by query.
Output Variable where result of the query will be stored at workflow runtime. Only variables of Collection type are available for this property.
If output type is Single output, there will be only one Output propery.
If output type is Separate output per column, there will be an Output propery for each column.
Items count Variable to store number of returned items. Only variables of Integer type are available for this property.

Examples

Get collection of “Support Issues” list item IDs where < Status > is equal to “New” and < Priority > is equal to “High”:


Get collection of IDs and collection of user logins using ODATA filter editor and sorting:


Query result must be stored in Collection variable even if only one item is returned.
OData-filter editor allows to use hidden fields, which are not available in query builder.