Worklist/Items

This content applies to legacy components (such as K2 Studio and K2 for Visual Studio), legacy assemblies, legacy services or legacy functionality. If you have upgraded from K2 blackpearl 4.7 to K2 Five, these items may still be available in your environment. These legacy items may not be available in new installations of K2 Five. These legacy items may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.

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