Worklist GET and PUT Methods

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.

The GET Method

When accessing the Worklist endpoint directly, the entire worklist for the logged on user will be returned.  This will be returned as an array of worklist items.  When using XML, the result will be nested under the following node:

<ArrayOfWorklistItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.k2.com/2013/web/rest/worklistitem.xsd" />

The GET/{SerialNumber} Method

To request a specific worklist item, use the api/worklistitem/{serialnumber} endpoint and provide the serial number of the item to retrieve, for example:
api/worklistitem/100_18

The PUT Method

Performing the PUT method against the api/worklistitem, will update a single worklist item.  The minimum requirement for this method is the serial number of the worklist item.

Schema examples

JSON

{
    "SerialNumber": "100_18"
}

XML

<WorklistItem
    xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://schemas.k2.com/2013/web/rest/worklistitem.xsd">
  <SerialNumber>100_18</SerialNumber>
</WorklistItem>