ListCases¶

Returns list of cases on specified channel.

1

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

Parameters¶

string channelId
    Id number of channel. Optional. If not specified search is performed in all channels.

string query
    Query to execute on cases.

number start
    Start number of results. Default is 0.

number length
    Maximum length of results. Default is 100

string columns
    Comma separated column names to include in result. If not specified all columns are returned.

string orderBy
    of list result

string order
    type of list result

Returns¶

Instance of DataTable that contains case list.

Remarks¶

Query syntax is based full text engine query language.

Search for word "foo" in the Subject field.¶

1

Subject:foo

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

1

Subject:"foo bar"

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

1

Subject:"foo bar" and Number:123

Search for all cases in closed at date range.¶

1

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

List cases on channel¶

1
2
3
4
5
6
7
8
9

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');

See Also¶

• DataTable