Worklist/Items
Returns a collection of worklist items for the current user.
URI
{Service Root URI}/Worklist/Items?{Query Options}
https://api.denallix.com:443/K2Services/REST.svc/Worklist/Items?piDataField=true&actXmlField=true
Method
GET
Query Options
No filters are applied if options are not provided.
Optional
- System Query Options
- Custom Query Options
- filterXml = {filterXml} – specifies the Worklist filtering and sorting to use to limit the results. Uses no filter when omitted, which will return all records. See the Filtering and Sorting section for more information.
- By default task detail data will not be returned. Changing either the service configuration (web.config) or providing these query options can override whether detail data is returned.
- piDataField (Boolean) – determines if process level data fields should be returned
- piXmlField (Boolean) – determines if process level XML fields should be returned
- actDataField (Boolean) – determines if activity level data fields should be returned
- actXmlField (Boolean) – determines if activity level XML fields should be returned
Return Type
WorklistItemCollection or Failure
GET /K2Services/REST.svc/Worklist/Items?$top=2&piDataField=true&piXmlField=true&actDataField=true
<?xml version="1.0" encoding="utf-8"?> <WorklistItemCollection xmlns="http://schemas.k2.com/worklist/d1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <WorklistItem AllocatedUser="K2:DENALLIX\BOB" ID="24" SerialNumber="18_10" Status="Available"> <Data>http://DLX:81/Workspace/ClientEventPages/K2_Examples/Order_Process_Page_9103682c.aspx?SN=18_10</Data> <Action Name="Approve" Batchable="true"/> <Action Name="Decline" Batchable="true"/> <Action Name="Rework" Batchable="true"/> <ProcessInstance ExpectedDuration="0" Folder="K2 Examples" Folio="Order Process - ACME" FullName="K2 Examples\Order Process" Guid="d71d0185-c2c4-44cf-bd9a-08c321b40460" ID="18" Name="Order Process" Priority="1" StartDate="2011-02-16T20:26:25.53Z" Status="Active" xmlns="http://schemas.k2.com/process/d1"> <Description/> <Metadata>Blank</Metadata> <DataField Name="MyProcessDataField">My process data field initial value</DataField> <XmlField Name="MyProcessXMLField"><XmlDocument>Some Process XML document</XmlDocument></XmlField> </ProcessInstance> <ActivityInstanceDestination ActID="9" ActInstID="7" ExpectedDuration="0" ID="10" Name="Manager Approval" Priority="1" ProcInstID="18" StartDate="2011-02-16T20:26:25.557Z" xmlns="http://schemas.k2.com/activity/d1"> <Description/> <Metadata/> <DataField Name="MyActivityDataField" xmlns="http://schemas.k2.com/process/d1">My activity data field initial value</DataField> </ActivityInstanceDestination> <ActivityInstanceDestination ExpectedDuration="0" ID="14" Name="Order Approval" Priority="1" StartDate="2011-02-16T20:26:28.107Z" xmlns="http://schemas.k2.com/event/d1"> <Description/> <Metadata/> </ActivityInstanceDestination> </WorklistItem> <WorklistItem AllocatedUser="K2:DENALLIX\BOB" ID="25" SerialNumber="19_10" Status="Available"> <Data>http://DLX:81/Workspace/ClientEventPages/K2_Examples/Order_Process_Page_9103682c.aspx?SN=19_10</Data> <Action Name="Approve" Batchable="true"/> <Action Name="Decline" Batchable="true"/> <Action Name="Rework" Batchable="true"/> <ProcessInstance ExpectedDuration="0" Folder="K2 Examples" Folio="Order Process - K2" FullName="K2 Examples\Order Process" Guid="7e8f9361-148e-44ec-8ed0-23f9d52ddfde" ID="19" Name="Order Process" Priority="1" StartDate="2011-02-16T20:26:29.343Z" Status="Active" xmlns="http://schemas.k2.com/process/d1"> <Description/> <Metadata>Blank</Metadata> <DataField Name="MyProcessDataField">My process data field initial value</DataField> <XmlField Name="MyProcessXMLField"><XmlDocument>Some Process XML document</XmlDocument></XmlField> </ProcessInstance> <ActivityInstanceDestination ActID="9" ActInstID="7" ExpectedDuration="0" ID="10" Name="Manager Approval" Priority="1" ProcInstID="19" StartDate="2011-02-16T20:26:29.43Z" xmlns="http://schemas.k2.com/activity/d1"> <Description/> <Metadata/> <DataField Name="MyActivityDataField" xmlns="http://schemas.k2.com/process/d1">My activity data field initial value</DataField> </ActivityInstanceDestination> <ActivityInstanceDestination ExpectedDuration="0" ID="14" Name="Order Approval" Priority="1" StartDate="2011-02-16T20:26:29.487Z" xmlns="http://schemas.k2.com/event/d1"> <Description/> <Metadata/> </ActivityInstanceDestination> </WorklistItem> </WorklistItemCollection>