Task/Items/UpdateTasks
Updates a multiple task items in batch with the data posted.
Only actions which have been configured to support batch processing can be updated via the Task service. Use the Worklist service to action items that do not support batch processing.
URI
{Service Root URI}/Task/Items/UpdateTasks
https://api.denallix.com:443/K2Services/SyncREST.svc/Task/Items/UpdateTasks
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
Ensure that the request has at least these headers set.
- Authorization – Basic or NTLM (Windows)
- Content-type – application/xml
|
Authorization: Basic {encrypted token goes here} |
Request Body
The request body contains an UpdateTaskCollection of the multiple UpdateTask items represented as XML. The Task item XML returned from Task GET methods can be used as a starting point for the XML input of this POST method. Any invalid elements or attributes will be ignored.
The UpdateTaskCollection XML consists of the following.
Namespaces
The UpdateTaskCollection XML requires namespaces to be defined.
- xmlns:t="http://schemas.k2.com/task/d1" (required) – contains the task attributes and nodes
- xmlns:p="http://schemas.k2.com/process/d1" (optional) – contains the nodes for process and activity data fields when provided
Elements and Attributes
- <UpdateTask>
-
- @ID (Integer, required) – a number assigned to the task action to link task item to action
-
@Action (String, required) – the type of action to perform. Available actions:
- a:[ActionName] – performs the process-specific action
- r:[FQN] – redirects a task to the user specified as a Fully Qualified Name
- d:[FQN] – delegates a task to the user specified as a Fully Qualified Name
-
s:[Duration] –performs the system action to sleep a task based on the duration provided.
- Duration = (>0) – sleeps the item the amount of seconds specified
- Duration = (0) – sleeps the item indefinitely
- Duration = (<0, e.g.-1) – wakes the item
- Duration = {DateTime} – sleeps the item until specified date time. Standard DateTime with time zone is supported: http://www.w3.org/TR/xmlschema11-2/#dateTime.
- <Task> – values not present in the XML for Task GET methods are not supported in updates.
-
- @SerialNumber (String, required) – the serial number of the task to update
- @Priority (Integer) – the priority to assign to the task
- @ProcessFolio (String) – the folio to assign to the task
- <ProcessDataField> (XML) – the process data fields to update in XML format. In .Net use XmlConvert.ToString to get the string value otherwise use XmlConvert.To[Type] to get the actual value.
- <ProcessXmlField> (XML) – the process XML fields as escaped XML. In .Net use XML objects to get the value: XmlDocument.InnerText, XmlReader.InnerText, XmlWriter.InnerText, or XDocument.Value.
- <ActivityDataField> (XML) – the activity data fields to update in XML format. In .Net use XmlConvert.ToString to get the string value otherwise use XmlConvert.To[Type] to get the actual value.
- <ActivityXmlField> (XML) – the activity XML fields as escaped XML. In .Net use XML objects to get the value: XmlDocument.InnerText, XmlReader.InnerText, XmlWriter.InnerText, or XDocument.Value.
Request Body Example
This POST will attempt to update two tasks. The first task (ID=1000) will perform the Rework action. The second task (ID=1001) will redirect to the DENALLIX\Joe user.
<?xml version=”1.0” encoding="utf-8"?>
<t:UpdateTaskCollection xmlns:t="http://schemas.k2.com/task/d1" xmlns:p="http://schemas.k2.com/process/d1">
<t:UpdateTask ID="1000" Action="a:Rework">
<t:Task SerialNumber="1_34" >
<p:ProcessDataField Name="MyProcessDataField">Some process data value</p:ProcessDataField>
<p:ProcessXmlField Name="MyProcXmlField"><XmlDocument>Some Process XML document</XmlDocument></p:ProcessXmlField>
<p:ActivityDataField Name="MyActDataField">Some activity data value</p:ActivityDataField>
<p:ActivityXmlField Name="MyActXmlField"><XmlDocument>Some Activity XML document</XmlDocument></p:ActivityXmlField>
</t:Task>
</t:UpdateTask>
<t:UpdateTask ID="1001" Action="r:DENALLIX\Joe">
<t:Task SerialNumber="2_34" >
<p:ProcessDataField Name="MyProcessDataField">Some process data value</p:ProcessDataField>
<p:ProcessXmlField Name="MyProcXmlField"><XmlDocument>Some Process XML document</XmlDocument></p:ProcessXmlField>
<p:ActivityDataField Name="MyActDataField">Some activity data value</p:ActivityDataField>
<p:ActivityXmlField Name="MyActXmlField"><XmlDocument>Some Activity XML document</XmlDocument></p:ActivityXmlField>
</t:Task>
</t:UpdateTask>
</t:UpdateTaskCollection>
Return Type
MultiOperationResult – a Success/Failure result for each Task item in the batch
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
The results of the batch POST show that one task (ID=1000) updated successfully while another task (ID=1001) failed because rights were insufficient.
Type your example code here. It will be automatically colorized when you POST /K2Services/SyncREST.svc/Task/Items/UpdateTasks
<?xml version="1.0" encoding="utf-8"?>
<MultipleOperationResult xmlns="http://schemas.k2.com/framework/d1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Failure ID="1001" Code="-1">
<Message>24411 K2:DENALLIX\Bob from 192.168.1.110:49 is not allowed to open the worklist item with SN=2_34</Message>
<Description>client- failure</Description>
</Failure>
<Success ID="1000"/>
</MultipleOperationResult>