< Back
Start-BTWorkflow
Post
NAME Start-BTWorkflow
SYNOPSIS
Start a Power365 Workflow.
SYNTAX
Start-BTWorkflow [-Identity] <object> [-Session <Session>] [<CommonParameters>]
DESCRIPTION
The Start-BTWorkflow -Identity Workflow (by object or id) cmdlet starts the specified Workflow.
The ApiKey role must be 'Writer' to run the Start-BTWorkflow cmdlet.
PARAMETERS
-Identity <object>
Specifies the identity (as a Workflow object or id) of a Workflow to start.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
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
Specifies the identity (as a Workflow object or id) of a Workflow to start.
OUTPUTS
BinaryTree.Power365.SDK.Workflow
---------- EXAMPLE 1 ----------
Start-BTWorkflow -Identity 4296
Start a Workflow.
RELATED LINKS
SYNOPSIS
Start a Power365 Workflow.
SYNTAX
Start-BTWorkflow [-Identity] <object> [-Session <Session>] [<CommonParameters>]
DESCRIPTION
The Start-BTWorkflow -Identity Workflow (by object or id) cmdlet starts the specified Workflow.
The ApiKey role must be 'Writer' to run the Start-BTWorkflow cmdlet.
PARAMETERS
-Identity <object>
Specifies the identity (as a Workflow object or id) of a Workflow to start.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
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
Specifies the identity (as a Workflow object or id) of a Workflow to start.
OUTPUTS
BinaryTree.Power365.SDK.Workflow
---------- EXAMPLE 1 ----------
Start-BTWorkflow -Identity 4296
Start a Workflow.
RELATED LINKS