Worklist GET and PUT Methods

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>

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