Workflow.StartWorkflow Method

Starts a workflow on an item for the client.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/workflow/StartWorkflow", RequestNamespace:="https://schemas.microsoft.com/sharepoint/soap/workflow/", ResponseNamespace:="https://schemas.microsoft.com/sharepoint/soap/workflow/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function StartWorkflow ( _
    item As String, _
    templateId As Guid, _
    workflowParameters As XmlNode _
) As XmlNode

'Usage
Dim instance As Workflow
Dim item As String
Dim templateId As Guid
Dim workflowParameters As XmlNode
Dim returnValue As XmlNode

returnValue = instance.StartWorkflow(item, templateId, workflowParameters)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/workflow/StartWorkflow", RequestNamespace="https://schemas.microsoft.com/sharepoint/soap/workflow/", ResponseNamespace="https://schemas.microsoft.com/sharepoint/soap/workflow/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public XmlNode StartWorkflow (
    string item,
    Guid templateId,
    XmlNode workflowParameters
)

Parameters

• item
  The URL location of an item on which a workflow is being run.

• templateId
  Globally unique identifier (GUID) of a template.

• workflowParameters
  The initiation form data.

Return Value

A System.Xml.XmlNode object.

Remarks

To complete the StartWorkflow call, information about the available workflows for an item must be provided by either the GetWorkflowDataForItem or GetTemplatesForItem method.

The workflowParameters parameter value is passed as the eventData parameter string value to the StartWorkflow method. For more information, see Workflow Association and Initiation Forms (Windows SharePoint Services) in the Windows SharePoint Services 3.0 SDK.

The return value contains no specific data. The return value denotes the end of the transaction.

See Also

Reference

Workflow Class
Workflow Members
Workflow Web Service