Processes

ProcessesService

Bases: FolderContext, BaseService

Service for managing and executing UiPath automation processes.

Processes (also known as automations or workflows) are the core units of automation in UiPath, representing sequences of activities that perform specific business tasks.

invoke(name, input_arguments=None, *, folder_key=None, folder_path=None)

Start execution of a process by its name.

Related Activity: Invoke Process

Parameters:

Name	Type	Description	Default
name	str	The name of the process to execute.	required
input_arguments	Optional[Dict[str, Any]]	The input arguments to pass to the process.	None
folder_key	Optional[str]	The key of the folder to execute the process in. Override the default one set in the SDK config.	None
folder_path	Optional[str]	The path of the folder to execute the process in. Override the default one set in the SDK config.	None

Returns:

Name	Type	Description
Job	Job	The job execution details.

Examples:

from uipath import UiPath

client = UiPath()

client.processes.invoke(name="MyProcess")

# if you want to execute the process in a specific folder
# another one than the one set in the SDK config
from uipath import UiPath

client = UiPath()

client.processes.invoke(name="MyProcess", folder_path="my-folder-key")

invoke_async(name, input_arguments=None, *, folder_key=None, folder_path=None) async

Asynchronously start execution of a process by its name.

Related Activity: Invoke Process

Parameters:

Name	Type	Description	Default
name	str	The name of the process to execute.	required
input_arguments	Optional[Dict[str, Any]]	The input arguments to pass to the process.	None
folder_key	Optional[str]	The key of the folder to execute the process in. Override the default one set in the SDK config.	None
folder_path	Optional[str]	The path of the folder to execute the process in. Override the default one set in the SDK config.	None

Returns:

Name	Type	Description
Job	Job	The job execution details.

Examples:

import asyncio

from uipath import UiPath

sdk = UiPath()

async def main():
    job = await sdk.processes.invoke_async("testAppAction")
    print(job)

asyncio.run(main())