Skip to content

Worklist Query

Worklist query is an XML-based string that specifies the desired result set. If not provided, the default query is executed.

The query can be defined using the following column names for specifying the result set columns, criteria, and order.

Available Query Columns

Name Description
Id Unique identifier of the work item.
Name Name of the work item.
Caption Localised caption of the work item.
State The current state of the work item.
Start Start date of the work item.
End End date of the work item. Can be null.
IsDeadlined A boolean that specifies the deadline has occurred.
DeadlineDate Deadline date. Can be null.
NextReminderDate Next reminder date. Can be null.
SentReminders Number of reminders sent.
Instructions Instructions for the work item.
InstanceId Unique identifier of the instance.
PreviousWorkItemId Identifier of the previous work item. Can be null.
ActionId Unique identifier for the action. Can be null.
CompletedById Id of the user who completed the work item. Can be null.
CompletedBy Display name of the user who completed the work item. Can be null.
Number Instance number.
Priority Priority of the instance.
ProcessId The Id of the process.
ProcessName The name of the process.
FromId Identifier of the initiating user. Can be null.
From Display name of the initiator user. Can be null.
FolderId Identifier of the related folder.
FolderName Name of the related folder.
AssignedTo List of users assigned to the work item.
VersionNumber Version number of the related process.
VersionId Version Id of the related process.
TestMode Boolean indicating whether the instance is in test mode.
Instance.Start Start date of the instance.
Instance.State State of the instance.

Query contains the following sections;

Query is syntax is same as database query. Please see Query page for more information.

Example Worklist Query Xml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<Query Start="" MaxLength="25">
    <Columns>
        <Column Expression="Id"/>
        <Column Expression="Instructions"/>
        <Column Expression="State"/>
        <Column Expression="FromId"/>
        <Column Expression="From"/>
        <Column Expression="SentReminders"/>
        <Column Expression="HasHistory"/>
        <Column Expression="Caption"/>
        <Column Expression="Start"/>
        <Column Expression="DeadlineDate"/>
        <Column Expression="End"/>
        <Column Expression="FolderName"/>
        <Column Expression="Number"/>
    </Columns>
    <Where>
        <Criteria>
            <Criteria Expression="Caption" Comparison="Like">
                <Value>My Task*</Value>
            </Criteria>
        </Criteria>
    </Where>
    <Order>
        <Order Expression="Start" Type="Descending" />
    </Order>
</Query>