ListCasesForIdentity¶
Returns a list of cases for the specified identity.
$Domain.ListCasesForIdentity(identity: ( string | Identity ), channelId?: string, query?: string, start?: number, length?: number, columns?: string, orderBy?: string, order?: string):DataTable (Identity, DataTable)
Parameters¶
( string | Identity ) identity
The user identity to search cases for (ID or Identity object).
string channelId optional
The ID of the channel. Optional. If not specified, the search is performed across all channels.
string query optional
A query to execute on the cases.
number start optional
The starting number of the results. The default is 0.
number length optional
The maximum number of results to return. The default is 100.
string columns optional
A comma-separated string of column names to include in the result. If not specified, all columns are returned.
string orderBy optional
The column to order the list results by.
string order optional
The type of ordering for the list results.
Returns¶
An instance of DataTable that contains the case list.
Remarks¶
This method is similar to $Domain.ListCases, but it returns cases that the specified identity has permission to access.
The supplied identity is resolved before searching, and only cases that identity may access are returned. An exception is thrown if the identity is not found. The same current orderBy/order forwarding behavior as ListCases applies.