Start-PnPWorkflowInstance

Starts a workflow instance on a list item

Syntax

Start-PnPWorkflowInstance
     -Subscription <WorkflowSubscriptionPipeBind>
                              -ListItem <ListItemPipeBind>
                              [-Web <WebPipeBind>]
                              [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem $item

Starts a workflow instance on the specified list item

------------------EXAMPLE 2------------------

Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem 2

Starts a workflow instance on the specified list item

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ListItem

The list item to start the workflow against

Type:ListItemPipeBind
Position:1
Accept pipeline input:False
Accept wildcard characters:False
-Subscription

The workflow subscription to start

Type:WorkflowSubscriptionPipeBind
Position:0
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False