Views

Views are pre-configured groups of properties that specify the sort and filter criteria included in the transaction query.

note

It's not possible to filter on multiple submission properties, so we recommend having just one submission property in the filterBy option.

Properties

All properties are optional unless otherwise indicated.

Property	Description
label	String (Default: null) Required. Text used as key and name of the view.
properties	List<Mapping> (Default: []) Required. List of property Mapping keys.
sortOrder	String (Default: "asc") Direction of the sort. Can be "asc" or "desc".
sortBy	String<Mapping> (Default: null) Mapping key.
filterBy	Map<Mapping, String/List/Map> (Default: null) Mapping key and value. Expressions can be used to set default values. For example, "{{ currentUser }}" or "{{ date('1 month ago') }}".
Queue	Map<Mapping, String> (Default: null) List of Queue values.

Examples

View with sort

{
  "label": "All Outstanding",
  "properties": [
    "$trackingCode",
    "$primaryApplicant",
    "$status",
    "$stepAge",
    "$assigned",
    "$product",
    "$lastModified"
  ],
  "sortOrder": "asc",
  "sortBy": "$assigned"
}

View with complex filters

{
  "label": "Opened last week",
  "properties": [
    "$trackingCode",
    "$primaryApplicant",
    "$status",
    "$stepAge",
    "$assigned",
    "$product",
    "$lastModified"
  ],
  "filterBy": {
    "$status": ["Opened", "None"],
    "$product": "All",
    "$stepAge": ["{{ date('1 week ago') }}", "{{ date('today') }}"]
  },
  "sortBy": "$stepAge"
}