Get-BTWorkflowRun

NAME Get-BTWorkflowRun



SYNOPSIS

Returns Power365 WorkflowRuns.





SYNTAX

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



Get-BTWorkflowRun [-Filter <string>] [-Limit <int>] [-Session <Session>] [-Workflow <object>] [<CommonParameters>]





DESCRIPTION

Get-WorkflowRun -Identity returns a WorkflowRun by WorkflowRunId or a WorkflowRun object.



Get-WorkflowRun [-Filter] [-Limit] [-Workflow] returns WorkflowRuns that match selection criteria.



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





PARAMETERS

-Identity <object>

WorkflowRun identity: WorkflowRunId or WorkflowRun object.



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Workflow <object>

Filter by Workflow (WorkflowId, Name, or Workflow object).



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Filter <string>

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

are WorkflowRunId, WorkflowId, and WorkflowName.



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

WorkflowRun identity: WorkflowRunId or WorkflowRun object.





OUTPUTS

BinaryTree.Power365.SDK.WorkflowRun





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



Get-WorkflowRun -Identity 766

Get-WorkflowRun -Identity $workflowRun

Gets a WorkflowRun by WorkflowRunId or WorkflowRun object.



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



Get-WorkflowRun

Returns all WorkflowRuns.



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



Get-WorkflowRun -Filter "WorkflowName -like 'M*'" -Limit 5

Returns the 5 most recent WorkflowRuns for Workflows whose names start with 'M'.





RELATED LINKS