Task/Items/Filtered

Returns a filtered and sorted collection of task items for the current user.

  Value Notes
URI {Service Root URI}/Task/Items/Filtered
e.g.
https://api.denallix.com:443/K2Services/SyncREST.svc/Task/Items/Filtered
 
Method POST

This method cannot be called via URI construction in the address bar of standard browsers.  Tooling such as Fiddler or .NET code may be required to execute the POST.

Only XML requests are allowed. JSON requests will result in a 202 Status code and the task will NOT be updated.

Request Headers Authorization: Basic {encrypted token goes here}
Content-type: application/xml

Ensure that the request has at least these headers set.

  • Authorization – Basic or NTLM (Windows)
  • Content-type – application/xml
Request Body  

 The request body contains the filter XML.  See the Filtering and Sorting section for more information on building a valid filter XML.

Request Body Example <Criteria xmlns="http://schemas.k2.com/worklist/d1">
  <Filter Field="ProcessFolio" Comparison="Like" ValueType="String">Demo</Filter>
  <Sort Field="ProcessStartDate" Order="Descending" />
</Criteria>

 
Return Type

TaskCollection or Failure

Due to the asynchronous nature of the POST, a successful call may not return anything depending on the tooling used to execute the POST.

Return Example <TaskCollection xmlns="http://schemas.k2.com/task/d1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Task SerialNumber="12_8">
    <ProcessName>Classic Rework</ProcessName>
    <StartDate>2011-07-07T06:09:06.063Z</StartDate>
    <ProcessFullName>K2 Examples\Classic Rework</ProcessFullName>
    <ProcessFolio>Classic Rework Demo2</ProcessFolio>
    <ActivityName>First Approval</ActivityName>
    <Priority>1</Priority>
    <Status>Available</Status>
    <Originator>K2:DENALLIX\administrator</Originator>
    <Data>http://DLX:81/Workspace/ClientEventPages/K2_Examples/Classic_Rework_Page_c5cc30cf.aspx?SN=12_8</Data>
    <Action Name="Approved" Batchable="true"/>
    <Action Name="Declined" Batchable="true"/>
    <Action Name="Rework" Batchable="true"/>
  </Task>
  <Task SerialNumber="11_8">
    <ProcessName>Classic Rework</ProcessName>
    <StartDate>2011-07-06T21:35:49.087Z</StartDate>
    <ProcessFullName>K2 Examples\Classic Rework</ProcessFullName>
    <ProcessFolio>Classic Rework Demo1</ProcessFolio>
    <ActivityName>First Approval</ActivityName>
    <Priority>1</Priority>
    <Status>Open</Status>
    <Originator>K2:DENALLIX\administrator</Originator>
    <Data>http://DLX:81/Workspace/ClientEventPages/K2_Examples/Classic_Rework_Page_c5cc30cf.aspx?SN=11_8</Data>
    <Action Name="Approved" Batchable="true"/>
    <Action Name="Declined" Batchable="true"/>
    <Action Name="Rework" Batchable="true"/>
  </Task>
</TaskCollection>

 

K2 blackpearl Developers Reference4.7
Video Links Learn Support
No videos found for this article
K2 on YouTube
No Additional links found for this article
No self-learning content for this article
Try some scenarios...
No relevant support links available for this article