Connectors Reference

Desktop flows

Enables desktop flows (previously called UI flows)

 

Status: Production

Tier: Premium

Version: 1.1

 

Actions:

Name

Summary

ListUIFlows (string uiFlowType)

List desktop flows

GetUIFlowMetadata (string uiFlowType, string uiFlowId)

Get desktop flow metadata

ExecuteDesktopUIFlow (string uiFlowId, [Optional]string runMode, [advanced][Optional]string runPriority, [Optional]DesktopUIFlowInput item)

Run a flow built with Windows recorder (V1)

ExecuteSeleniumIDEUIFlow (string uiFlowId, [Optional]string runMode, [advanced][Optional]string runPriority, SeleniumIDEUIFlowInput item)

Run a flow built with Selenium IDE

RunUIFlow_V2 (string uiFlowId, string runMode, [advanced][Optional]string runPriority, [Optional]DesktopV2UIFlowInput item)

Run a flow built with Power Automate Desktop

GetRunStatus (string uiFlowType, string uiFlowId, string runId)

Gets desktop flow run

TestConnection ()

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

GetScriptRunReferencedBinaryInternal (string scriptId, string runId, string binaryId, string api-version, [Optional]string $skipToken)

Get script run referenced binaries internal

Status ([Optional]string api-version)

Get agent status

FinishRunInternal (string scriptId, string runId, string api-version)

Complete script execution

TestConnectionInternal ([Optional]string api-version)

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

SendBinaryChunkInternal (string scriptId, string runId, string binaryGroupingId, string binaryId, string api-version, RoboticProcessAutomationSendBinaryRequest item)

Send chunk of binaries to be used by the script

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CancelInternalResponse

 

DesktopUIFlowInput

 

DesktopV2UIFlowInput

 

ExecuteDesktopUIFlowResponse

 

ExecuteScriptInternalResponse

 

ExecuteSeleniumIDEUIFlowResponse

 

GetScriptRunActionsInternalResponse

 

GetScriptRunInternalResponse

 

GetScriptRunReferencedBinaryInternalResponse

 

NotifyBinariesSentInternalResponse

 

Object

 

RoboticProcessAutomationSendBinaryRequest

 

RunUIFlow_V2Response

 

SeleniumIDEUIFlowInput

 

SendBinaryChunkInternalResponse

 

StatusResponse

 

TestConnectionInternalResponse

 

 

Actions:

ListUIFlows

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

 

GetUIFlowMetadata

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

 

ExecuteDesktopUIFlow

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

ListUIFlows

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

DesktopUIFlowInput

 

Desktop flow input

False

 

Returns:

          Type:ExecuteDesktopUIFlowResponse

 

ExecuteSeleniumIDEUIFlow

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

ListUIFlows

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

SeleniumIDEUIFlowInput

 

 

True

 

Returns:

          Type:ExecuteSeleniumIDEUIFlowResponse

 

RunUIFlow_V2

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

ListUIFlows

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

DesktopV2UIFlowInput

 

Power Automate Desktop flow input

False

 

Returns:

          Type:RunUIFlow_V2Response

 

GetRunStatus

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:

 

TestConnection

Summary: Test the desktop flow service connection

Description: Test the desktop flow service connection.

 

Syntax:

Desktopflows.TestConnection ()

 

Returns:

 

ExecuteScriptInternal

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

Object

 

 

False

 

Returns:

          Type:ExecuteScriptInternalResponse

 

GetScriptRunInternal

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

 

GetScriptRunActionsInternal

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

 

GetScriptRunReferencedBinaryInternal

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

 

Status

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

 

FinishRunInternal

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:

 

TestConnectionInternal

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

 

NotifyBinariesSentInternal

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

 

CancelInternal

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:

          Type:CancelInternalResponse

 

SendBinaryChunkInternal

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

 


 

CancelInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DesktopUIFlowInput

Summary:

Description: Desktop flow input

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

DesktopV2UIFlowInput

Summary:

Description: Power Automate Desktop flow input

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

ExecuteDesktopUIFlowResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ExecuteScriptInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ExecuteSeleniumIDEUIFlowResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetScriptRunActionsInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetScriptRunInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetScriptRunReferencedBinaryInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

NotifyBinariesSentInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

RoboticProcessAutomationSendBinaryRequest

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.


 

RunUIFlow_V2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SeleniumIDEUIFlowInput

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

Variables

 

 

 

Variables

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

SendBinaryChunkInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

StatusResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TestConnectionInternalResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary