Get-PnPWorkflowDefinition

Returns a workflow definition

Syntax

Get-PnPWorkflowDefinition
   [-Name <String>]
                            [-PublishedOnly [<SwitchParameter>]]
                            [-Web <WebPipeBind>]
                            [-Connection <SPOnlineConnection>]

Description

Returns a workflow definition

Examples

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

Get-PnPWorkflowDefinition -Name MyWorkflow

Gets a Workflow with the name "MyWorkflow".

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

Get-PnPWorkflowDefinition -Name MyWorkflow -PublishedOnly $false

Gets a Workflow with the name "MyWorkflow" that is published.

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
-Name

The name of the workflow

Type:String
Position:0
Accept pipeline input:False
Accept wildcard characters:False
-PublishedOnly

Return only the published workflows

Type:SwitchParameter
Position:Named
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

Outputs

Microsoft.SharePoint.Client.WorkflowServices.WorkflowDefinition