Partager via


RunDesktopFlow Action

Trigger a new run of a desktop flow.

Bound entities

Bound actions are invoked by appending the fully qualified action name to the URI representing an entity or collection.

Entity Type Binding Type
workflow entity

Parameters

Parameters allow for data to be passed to the action.

Name Type Nullable Unicode Description
callbackUrl
Edm.String True False

URL that will be called once the desktop flow script is complete.

runPriority
Edm.String True False

Choose an option (normal, high) or add your own.

connectionName
Edm.String False False

Identifies the connection to be used with the desktop flow script.

inputs
Edm.String True False

The desktop flow script input parameters (json serialized string).

runMode
Edm.String False False

Choose between running while signed in (attended) or in the background (unattended).

timeout
Edm.Int32 True True

Timeout for script execution in seconds (default = 3 hours, max = 24 hours).

connectionType
Edm.Int32 True True

Identifies which type of connection is used in the connectionName parameter : 1 is for a connection type (default), 2 is for a connection reference type.

Return type

Type Nullable Description
RunDesktopFlowResponse False Contains the response of the RunDesktopFlow action.

See also