WorkflowInstanceService.StartWorkflowOnListItem method

Starts a Workflow Manager Client 1.0 instance of the specified WorkflowSubscription on the list item.

Namespace:  Microsoft.SharePoint.WorkflowServices
Assembly:  Microsoft.SharePoint.WorkflowServicesBase (in Microsoft.SharePoint.WorkflowServicesBase.dll)


<ClientCallableMethodAttribute> _
Public MustOverride Function StartWorkflowOnListItem ( _
    subscription As WorkflowSubscription, _
    itemId As Integer, _
    payload As IDictionary(Of String, Object) _
) As Guid
Dim instance As WorkflowInstanceService
Dim subscription As WorkflowSubscription
Dim itemId As Integer
Dim payload As IDictionary(Of String, Object)
Dim returnValue As Guid

returnValue = instance.StartWorkflowOnListItem(subscription, _
    itemId, payload)
public abstract Guid StartWorkflowOnListItem(
    WorkflowSubscription subscription,
    int itemId,
    IDictionary<string, Object> payload


  • itemId
    Type: System.Int32

    The integer id of the list item on which to start the workflow instance.

Return value

Type: System.Guid
Returns the workflow instance to be started, with id of the list item on which to start.

See also


WorkflowInstanceService class

WorkflowInstanceService members

Microsoft.SharePoint.WorkflowServices namespace