Page Comparison

Overview

Returns list of cases on specified channel.

DataTable $Domain.ListCases(channelId: string, query: string, start: number, length: number, columns: string, orderBy: string, order: string)

Arguments

Returns

Instance of DataTable that contains case list.

Remarks

Query syntax is based full text engine query language.

Example

Search for word "foo" in the Subject field.

Code Block
language javascript
``` Subject:foo

Example

Search for phrase "foo bar" in the title field.

Code Block
language javascript
``` Subject:"foo bar"

Example

Search for phrase "foo bar" in the Subject field AND the 123 value in Number field.

Code Block
language javascript
``` Subject:"foo bar" and Number:123 ```` @example Search for all cases in closed at date range.

, ClosedAt:[2020-01-01 TO 2021-01-01] ,

Code Block
language javascript
``` @example List cases on channel

,js var channelId = settings[0].Evaluate('ChannelId'); var columns = ["Id", "Subject", "Number", "CreatedAt", "CreatedBy", "CreatedByName", "UpdatedAt", "ClosedAt", "IsClosed", "TotalTimeSpent", "Priority"].join(','); var query = "IsClosed:'False' OR ClosedAt:[" + $Xml.EvaluateDateTime('Start').toJSON() + " TO " + $Xml.EvaluateDateTime('End').toJSON() + "]"; var cases = $Domain.ListCases(channelId, query, 0, 1000, columns); console.log('found ' + cases.RowCount() + ' case'); ```