Workflow.AlterToDo Method

Updates the task information for a specific workflow task.

Web Service: WorkflowWeb Reference: http://<Site>/_vti_bin/Workflow.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/workflow/AlterToDo", RequestNamespace:="http://schemas.microsoft.com/sharepoint/soap/workflow/", ResponseNamespace:="http://schemas.microsoft.com/sharepoint/soap/workflow/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function AlterToDo ( _
    item As String, _
    todoId As Integer, _
    todoListId As Guid, _
    taskData As XmlNode _
) As XmlNode
'Usage
Dim instance As Workflow
Dim item As String
Dim todoId As Integer
Dim todoListId As Guid
Dim taskData As XmlNode
Dim returnValue As XmlNode

returnValue = instance.AlterToDo(item, todoId, todoListId, taskData)
[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/workflow/AlterToDo", RequestNamespace="http://schemas.microsoft.com/sharepoint/soap/workflow/", ResponseNamespace="http://schemas.microsoft.com/sharepoint/soap/workflow/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public XmlNode AlterToDo (
    string item,
    int todoId,
    Guid todoListId,
    XmlNode taskData
)

Parameters

  • item
    The URL location of an item on which a workflow is being run.
  • todoId
    Unique identifier of the assigned task.
  • todoListId
    Globally unique identifier (GUID) of the assigned task list containing the task.
  • taskData
    Task data for conversion into a hash table.

Return Value

A System.Xml.XmlNode object.

Remarks

The AlterToDo method lets users edit or complete a workflow task from the client. You must make a SOAP workflow query call to either the GetWorkflowDataForItem method or GetToDosForItem method to complete the AlterToDo call. The GetWorkflowDataForItem method or GetToDosForItem method provides the information about the task to be edited.

The server parses the <taskData> node into a hash table with a key for each <elementX> tag. The inner value of that tag is the value of the key in the hash table. The resulting hash table is passed to the AlterTask method as the htData parameter. The other items in the request, for example, the URL location of the item, the assigned task, and so on are used to identify the task.

See Also

Reference

Workflow Class
Workflow Members
Workflow Web Service