Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 2.15 KB

Get-PnPWorkflowInstance.md

File metadata and controls

91 lines (67 loc) · 2.15 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Get-PnPWorkflowInstance

SYNOPSIS

Get workflow instances

SYNTAX

Get-PnPWorkflowInstance -List <ListPipeBind>
                        -ListItem <ListItemPipeBind>
                        [-Web <WebPipeBind>]
                        [-Connection <SPOnlineConnection>]

DESCRIPTION

Gets all workflow instances

EXAMPLES

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

PS:> Get-PnPWorkflowInstance -List "My Library" -ListItem $ListItem

Retrieves workflow instances running against the provided item on list "My Library"

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

PS:> Get-PnPWorkflowInstance -List "My Library" -ListItem 2

Retrieves workflow instances running against the provided item with 2 in the list "My Library"

PARAMETERS

-List

The List for which workflow instances should be retrieved

Type: ListPipeBind
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: False

-ListItem

The List Item for which workflow instances should be retrieved

Type: ListItemPipeBind
Parameter Sets: (All)

Required: True
Position: 1
Accept pipeline input: False

-Connection

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

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: 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
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices