Enables desktop flows (previously called UI flows)
Status: Production |
Tier: Premium |
Version: 1.1 |
Name |
Summary |
List desktop flows |
|
Get desktop flow metadata |
|
Run a flow built with Windows recorder (V1) |
|
Run a flow built with Selenium IDE |
|
Run a flow built with Power Automate Desktop |
|
GetRunStatus (string uiFlowType, string uiFlowId, string runId) |
Gets desktop flow run |
Test the desktop flow service connection |
|
ExecuteScriptInternal (string scriptId, string runId, string api-version, [Optional]Object item) |
Execute script internal |
GetScriptRunInternal (string scriptId, string runId, string api-version) |
Get script run internal |
GetScriptRunActionsInternal (string scriptId, string runId, string api-version) |
Get script run actions internal |
Get script run referenced binaries internal |
|
Get agent status |
|
FinishRunInternal (string scriptId, string runId, string api-version) |
Complete script execution |
Test desktop flow service connection |
|
NotifyBinariesSentInternal (string scriptId, string runId, string api-version) |
Notify binaries required to run the script have been sent |
CancelInternal (string scriptId, string runId, string api-version) |
Cancel the execution of a specific run |
Send chunk of binaries to be used by the script |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List desktop flows
Description: List desktop flows.
Syntax:
Desktopflows.ListUIFlows (string uiFlowType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uiFlowType |
string (Desktop flow type.) |
The desktop flow type. |
True |
Returns:
Type:Object
Summary: Get desktop flow metadata
Description: Get desktop flow metadata.
Syntax:
Desktopflows.GetUIFlowMetadata (string uiFlowType, string uiFlowId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uiFlowType |
string (Desktop flow type.) |
The desktop flow type. |
True |
|
uiFlowId |
string
|
The desktop flow id. |
True |
Returns:
Type:Object
Summary: Run a flow built with Windows recorder (V1)
Description: A flow will automatically run a set of steps recorded in a single app using Windows recorder (V1).
Syntax:
Desktopflows.ExecuteDesktopUIFlow (string uiFlowId, [Optional]string runMode, [advanced][Optional]string runPriority, [Optional]DesktopUIFlowInput item)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uiFlowId |
string (Desktop flow) |
Choose an option or create your own |
True |
|
runMode |
string (Run Mode)Values: [attended, unattended] |
Choose between running while signed in (attended) or in the background (unattended). |
False |
|
runPriority |
string (Priority (preview))Values: [high, normal] |
Choose an option or add your own |
False |
|
item |
|
Desktop flow input |
False |
Returns:
Type:ExecuteDesktopUIFlowResponse
Summary: Run a flow built with Selenium IDE
Description: A web flow will automatically run a set of steps recorded in a single web app, using Selenium IDE.
Syntax:
Desktopflows.ExecuteSeleniumIDEUIFlow (string uiFlowId, [Optional]string runMode, [advanced][Optional]string runPriority, SeleniumIDEUIFlowInput item)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uiFlowId |
string (Desktop flow) |
Choose an option or create your own. |
True |
|
runMode |
string (Run Mode)Values: [attended, unattended] |
Choose between running while signed in (attended) or in the background (unattended). |
False |
|
runPriority |
string (Priority (preview))Values: [high, normal] |
Choose an option or add your own |
False |
|
item |
|
|
True |
Returns:
Type:ExecuteSeleniumIDEUIFlowResponse
Summary: Run a flow built with Power Automate Desktop
Description: A flow will automatically run a set of steps built by Power Automate Desktop.
Syntax:
Desktopflows.RunUIFlow_V2 (string uiFlowId, string runMode, [advanced][Optional]string runPriority, [Optional]DesktopV2UIFlowInput item)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uiFlowId |
string (Desktop flow) |
Choose an option or create your own |
True |
|
runMode |
string (Run Mode)Values: [attended, unattended] |
Choose between running while signed in (attended) or in the background (unattended). |
True |
|
runPriority |
string (Priority (preview))Values: [high, normal] |
Choose an option or add your own |
False |
|
item |
|
Power Automate Desktop flow input |
False |
Returns:
Type:RunUIFlow_V2Response
Summary: Gets desktop flow run
Description: Gets the desktop flow run.
Syntax:
Desktopflows.GetRunStatus (string uiFlowType, string uiFlowId, string runId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
uiFlowType |
string (Desktop flow type.) |
The desktop flow type. |
True |
|
uiFlowId |
string (Desktop flow id) |
The desktop flow id. |
True |
|
runId |
string (Run id) |
The run id. |
True |
Returns:
Summary: Test the desktop flow service connection
Description: Test the desktop flow service connection.
Syntax:
Desktopflows.TestConnection ()
Returns:
Summary: Execute script internal
Description: Execute script internal.
Syntax:
Desktopflows.ExecuteScriptInternal (string scriptId, string runId, string api-version, [Optional]Object item)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
api-version |
string
|
|
True |
|
item |
|
|
False |
Returns:
Type:ExecuteScriptInternalResponse
Summary: Get script run internal
Description: Get script run internal.
Syntax:
Desktopflows.GetScriptRunInternal (string scriptId, string runId, string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
api-version |
string
|
|
True |
Returns:
Type:GetScriptRunInternalResponse
Summary: Get script run actions internal
Description: Get script run internal.
Syntax:
Desktopflows.GetScriptRunActionsInternal (string scriptId, string runId, string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
api-version |
string
|
|
True |
Returns:
Type:GetScriptRunActionsInternalResponse
Summary: Get script run referenced binaries internal
Description: Get script run referenced binaries internal.
Syntax:
Desktopflows.GetScriptRunReferencedBinaryInternal (string scriptId, string runId, string binaryId, string api-version, [Optional]string $skipToken)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
binaryId |
string
|
|
True |
|
api-version |
string
|
|
True |
|
$skipToken |
string
|
|
False |
Returns:
Type:GetScriptRunReferencedBinaryInternalResponse
Summary: Get agent status
Description: Get agent status.
Syntax:
Desktopflows.Status ([Optional]string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
api-version |
string
|
|
False |
Returns:
Type:StatusResponse
Summary: Complete script execution
Description: Complete script execution.
Syntax:
Desktopflows.FinishRunInternal (string scriptId, string runId, string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
api-version |
string
|
|
True |
Returns:
Summary: Test desktop flow service connection
Description: Test desktop flow service connection.
Syntax:
Desktopflows.TestConnectionInternal ([Optional]string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
api-version |
string
|
|
False |
Returns:
Type:TestConnectionInternalResponse
Summary: Notify binaries required to run the script have been sent
Description: Notify binaries required to run the script have been sent.
Syntax:
Desktopflows.NotifyBinariesSentInternal (string scriptId, string runId, string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
api-version |
string
|
|
True |
Returns:
Type:NotifyBinariesSentInternalResponse
Summary: Cancel the execution of a specific run
Description: Cancel the execution of a specific run.
Syntax:
Desktopflows.CancelInternal (string scriptId, string runId, string api-version)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
api-version |
string
|
|
True |
Returns:
Summary: Send chunk of binaries to be used by the script
Description: Send chunk of binaries to be used by the script.
Syntax:
Desktopflows.SendBinaryChunkInternal (string scriptId, string runId, string binaryGroupingId, string binaryId, string api-version, RoboticProcessAutomationSendBinaryRequest item)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
scriptId |
string
|
|
True |
|
runId |
string
|
|
True |
|
binaryGroupingId |
string
|
|
True |
|
binaryId |
string
|
|
True |
|
api-version |
string
|
|
True |
|
item |
RoboticProcessAutomationSendBinaryRequest
|
Binary chunk to be used by the script |
True |
Returns:
Type:SendBinaryChunkInternalResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Desktop flow input
Properties:
Name |
Type |
Summary |
schema |
|
|
Summary:
Description: Power Automate Desktop flow input
Properties:
Name |
Type |
Summary |
schema |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Binary chunk to be used by the script
Properties:
Name |
Type |
Summary |
value |
string Chunk of binary |
Chunk of binary. |
chunkID |
string Id of the Chunk |
Add a timed pause between steps (milliseconds). |
totalChunks |
string number of chunks |
number of chunks. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
browser |
string Web browser |
Choose the browser you’ll be using. Values: [Microsoft Edge (Chromium), Google Chrome] |
stepDelay |
integer Step delay |
Add a timed pause between steps (milliseconds). |
stepTimeout |
integer Auto timeout |
Enter the length of time before a run fails (milliseconds). |
variables |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |