Action Center

TasksService ¶

Service for managing UiPath Action Center tasks.

Tasks are task-based automation components that can be integrated into applications and processes. They represent discrete units of work that can be triggered and monitored through the UiPath API.

This service provides methods to create and retrieve tasks, supporting both app-specific and generic tasks. It inherits folder context management capabilities from FolderContext.

Reference: https://docs.uipath.com/automation-cloud/docs/actions

create ¶

create(
    title,
    data=None,
    *,
    app_name=None,
    app_key=None,
    app_folder_path=None,
    app_folder_key=None,
    assignee=None,
)

Creates a new task synchronously.

This method creates a new action task in UiPath Orchestrator. The action can be either app-specific (using app_name or app_key) or a generic action.

Parameters:

Name	Type	Description	Default
`title`	`str`	The title of the action	required
`data`	`dict[str, Any] \| None`	Optional dictionary containing input data for the action	`None`
`app_name`	`str \| None`	The name of the application (if creating an app-specific action)	`None`
`app_key`	`str \| None`	The key of the application (if creating an app-specific action)	`None`
`app_folder_path`	`str \| None`	Optional folder path for the action	`None`
`app_folder_key`	`str \| None`	Optional folder key for the action	`None`
`assignee`	`str \| None`	Optional username or email to assign the task to	`None`

Returns:

Name	Type	Description
`Action`	`Task`	The created action object

Raises:

Type	Description
`Exception`	If neither app_name nor app_key is provided for app-specific actions

create_async `async` ¶

create_async(
    title,
    data=None,
    *,
    app_name=None,
    app_key=None,
    app_folder_path=None,
    app_folder_key=None,
    assignee=None,
)

Creates a new action asynchronously.

This method creates a new action task in UiPath Orchestrator. The action can be either app-specific (using app_name or app_key) or a generic action.

Parameters:

Name	Type	Description	Default
`title`	`str`	The title of the action	required
`data`	`dict[str, Any] \| None`	Optional dictionary containing input data for the action	`None`
`app_name`	`str \| None`	The name of the application (if creating an app-specific action)	`None`
`app_key`	`str \| None`	The key of the application (if creating an app-specific action)	`None`
`app_folder_path`	`str \| None`	Optional folder path for the action	`None`
`app_folder_key`	`str \| None`	Optional folder key for the action	`None`
`assignee`	`str \| None`	Optional username or email to assign the task to	`None`

Returns:

Name	Type	Description
`Action`	`Task`	The created action object

Raises:

Type	Description
`Exception`	If neither app_name nor app_key is provided for app-specific actions

retrieve ¶

retrieve(action_key, app_folder_path='', app_folder_key='')

Retrieves a task by its key synchronously.

Parameters:

Name	Type	Description	Default
`action_key`	`str`	The unique identifier of the task to retrieve	required
`app_folder_path`	`str`	Optional folder path for the task	`''`
`app_folder_key`	`str`	Optional folder key for the task	`''`

Returns:

Name	Type	Description
`Task`	`Task`	The retrieved task object

retrieve_async `async` ¶

retrieve_async(
    action_key, app_folder_path="", app_folder_key=""
)

Retrieves a task by its key asynchronously.

Parameters:

Name	Type	Description	Default
`action_key`	`str`	The unique identifier of the task to retrieve	required
`app_folder_path`	`str`	Optional folder path for the task	`''`
`app_folder_key`	`str`	Optional folder key for the task	`''`

Returns:

Name	Type	Description
`Task`	`Task`	The retrieved task object

Action Center

TasksService ¶

create ¶

create_async async ¶

retrieve ¶

retrieve_async async ¶

create_async `async` ¶

retrieve_async `async` ¶