Task/Items/UpdateTask

Updates a single task with the data posted.

URI

{Service Root URI}/Task/Items/UpdateTask
https://api.denallix.com:443/K2Services/SyncREST.svc/Task/Items/UpdateTask

Method

POST

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} Content-type: application/xml

Request Body

The request body contains the UpdateTask item 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 UpdateTask XML consists of the following.

Namespaces

The UpdateTask 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.
    

Return Type

Success/Failure