Task/Items

Returns a collection of task items for the current user limited by the query options.

  Value Notes
URI {Service Root URI}/Task/Items?{Query Options}
e.g.
https://api.denallix.com:443/K2Services/SyncREST.svc/Task/Items?piDataField=true&piXmlField=true

No filters are applied if options are not provided.

Optional Query options can be passed, see
System Query Options

  • Custom Query Options
    • filterXml = {filterXml} – specifies the task 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
Method GET  
Return Type TaskCollection or Failure  
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="17_10">
    <ProcessName>Order Process</ProcessName>
    <StartDate>2011-02-15T01:22:45.017Z</StartDate>
    <ProcessFullName>K2 Examples\Order Process</ProcessFullName>
    <ProcessFolio>Order Process - K2</ProcessFolio>
    <ActivityName>Manager Approval</ActivityName>
    <Priority>1</Priority>
    <Status>Available</Status>
    <Originator>K2:DENALLIX\BOB</Originator>
    <Data>http://DLX:81/Workspace/ClientEventPages/K2_Examples/Order_Process_Page_9103682c.aspx?SN=17_10</Data>
    <Action Name="Approve" Batchable="true"/>
    <Action Name="Decline" Batchable="true"/>
    <Action Name="Rework" Batchable="true"/>
    <ProcessDataField Name="MyProcessDataField" xmlns="http://schemas.k2.com/process/d1">My process data field initial value</ProcessDataField>
    <ProcessXmlField Name="MyProcessXMLField" xmlns="http://schemas.k2.com/process/d1">
      <items>
        <item>
          <id>1</id>
          <name>Widgets</name>
          <quantity>4</quantity>
        </item>
      </items>
    </ProcessXmlField>
  </Task>
  <Task SerialNumber="18_10">
    <ProcessName>Order Process</ProcessName>
    <StartDate>2011-02-15T01:41:27.113Z</StartDate>
    <ProcessFullName>K2 Examples\Order Process</ProcessFullName>
    <ProcessFolio>Order Process - Acme</ProcessFolio>
    <ActivityName>Manager Approval</ActivityName>
    <Priority>1</Priority>
    <Status>Available</Status>
    <Originator>K2:DENALLIX\BOB</Originator>
    <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"/>
    <ProcessDataField Name="MyProcessDataField" xmlns="http://schemas.k2.com/process/d1">My process data field initial value</ProcessDataField>
    <ProcessXmlField Name="MyProcessXMLField" xmlns=">http://schemas.k2.com/process/d1">
      <items>
        <item>
          <id>1</id>
          <name>Widgets</name>
          <quantity>4</quantity>
        </item>
      </items>
    </ProcessXmlField>
  </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