Get-BTWorkflow

NAME Get-BTWorkflow



SYNOPSIS

Returns Power365 Workflows.





SYNTAX

Get-BTWorkflow [-Identity] <object> [-Session <Session>] [<CommonParameters>]



Get-BTWorkflow [-Filter <string>] [-Limit <int>] [-Session <Session>] [<CommonParameters>]





DESCRIPTION

Get-BTWorkflow -Identity returns a Workflow by WorkflowId, identity, or a Workflow object.



Get-BTWorkflow [-Filter] [-Limit] returns Workflows that match selection criteria.



The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWorkflow cmdlet.





PARAMETERS

-Identity <object>

Workflow identity: WorkflowId, Name, or a Workflow object.



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Filter <string>

Filter expression. The filter is in OPath syntax, such as "Name -like 'My*'". The supported properties are

WorkflowId and Name.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Limit <int>

Limit the number of returned items.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Session <Session>

The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Object

Workflow identity: WorkflowId, Name, or a Workflow object.





OUTPUTS

BinaryTree.Power365.SDK.Workflow





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



Get-BTWorkflow -Identity 107

Get-BTWorkflow -Identity 'My Workflow'

Get-BTWorkflow -Identity $workflow

Returns a Workflow by WorkflowId, identity, or a Workflow object.



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



Get-BTWorkflow

Returns all Workflows.



---------- EXAMPLE 3 ----------



Get-BTWorkflow -Filter "Name -like 'M*'" -Limit 3

Returns the first 3 Workflows whose Name starts with 'M'.





RELATED LINKS