Queues

QueuesService ¶

Service for managing UiPath queues and queue items.

Queues are a fundamental component of UiPath automation that enable distributed and scalable processing of work items.

complete_transaction_item ¶

complete_transaction_item(
    transaction_key,
    result,
    queue_name=None,
    *,
    folder_key=None,
    folder_path=None,
)

Completes a transaction item with the specified result.

Parameters:

Name	Type	Description	Default
`transaction_key`	`str`	Unique identifier of the transaction to complete.	required
`result`	`dict[str, Any] \| TransactionItemResult`	Result data for the transaction, either as a dictionary or TransactionItemResult instance.	required
`queue_name`	`str \| None`	The name of the queue the transaction belongs to.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response confirming the transaction completion.

Related Activity: Set Transaction Status

complete_transaction_item_async `async` ¶

complete_transaction_item_async(
    transaction_key,
    result,
    queue_name=None,
    *,
    folder_key=None,
    folder_path=None,
)

Asynchronously completes a transaction item with the specified result.

Parameters:

Name	Type	Description	Default
`transaction_key`	`str`	Unique identifier of the transaction to complete.	required
`result`	`dict[str, Any] \| TransactionItemResult`	Result data for the transaction, either as a dictionary or TransactionItemResult instance.	required
`queue_name`	`str \| None`	The name of the queue the transaction belongs to.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response confirming the transaction completion.

Related Activity: Set Transaction Status

create_item ¶

create_item(
    item,
    queue_name=None,
    *,
    folder_key=None,
    folder_path=None,
)

Creates a new queue item in the Orchestrator.

Parameters:

Name	Type	Description	Default
`item`	`dict[str, Any] \| QueueItem`	Queue item data, either as a dictionary or QueueItem instance.	required
`queue_name`	`str \| None`	The name of the queue. Overrides item.name when provided.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the created queue item details.

Related Activity: Add Queue Item

create_item_async `async` ¶

create_item_async(
    item,
    queue_name=None,
    *,
    folder_key=None,
    folder_path=None,
)

Asynchronously creates a new queue item in the Orchestrator.

Parameters:

Name	Type	Description	Default
`item`	`dict[str, Any] \| QueueItem`	Queue item data, either as a dictionary or QueueItem instance.	required
`queue_name`	`str \| None`	The name of the queue. Overrides item.name when provided.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the created queue item details.

Related Activity: Add Queue Item

create_items ¶

create_items(
    items,
    queue_name,
    commit_type,
    *,
    folder_key=None,
    folder_path=None,
)

Creates multiple queue items in bulk.

Parameters:

Name	Type	Description	Default
`items`	`list[dict[str, Any] \| QueueItem]`	List of queue items to create, each either a dictionary or QueueItem instance.	required
`queue_name`	`str`	Name of the target queue.	required
`commit_type`	`CommitType`	Type of commit operation to use for the bulk operation.	required
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the bulk operation result.

create_items_async `async` ¶

create_items_async(
    items,
    queue_name,
    commit_type,
    *,
    folder_key=None,
    folder_path=None,
)

Asynchronously creates multiple queue items in bulk.

Parameters:

Name	Type	Description	Default
`items`	`list[dict[str, Any] \| QueueItem]`	List of queue items to create, each either a dictionary or QueueItem instance.	required
`queue_name`	`str`	Name of the target queue.	required
`commit_type`	`CommitType`	Type of commit operation to use for the bulk operation.	required
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the bulk operation result.

create_transaction_item ¶

create_transaction_item(
    item,
    queue_name=None,
    no_robot=False,
    *,
    folder_key=None,
    folder_path=None,
)

Creates a new transaction item in a queue.

Parameters:

Name	Type	Description	Default
`item`	`dict[str, Any] \| TransactionItem`	Transaction item data, either as a dictionary or TransactionItem instance.	required
`queue_name`	`str \| None`	The name of the queue. Overrides item.name when provided.	`None`
`no_robot`	`bool`	If True, the transaction will not be associated with a robot. Defaults to False.	`False`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the transaction item details.

create_transaction_item_async `async` ¶

create_transaction_item_async(
    item,
    queue_name=None,
    no_robot=False,
    *,
    folder_key=None,
    folder_path=None,
)

Asynchronously creates a new transaction item in a queue.

Parameters:

Name	Type	Description	Default
`item`	`dict[str, Any] \| TransactionItem`	Transaction item data, either as a dictionary or TransactionItem instance.	required
`queue_name`	`str \| None`	The name of the queue. Overrides item.name when provided.	`None`
`no_robot`	`bool`	If True, the transaction will not be associated with a robot. Defaults to False.	`False`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the transaction item details.

list_items ¶

list_items(
    queue_name=None, *, folder_key=None, folder_path=None
)

Retrieves a list of queue items from the Orchestrator.

Parameters:

Name	Type	Description	Default
`queue_name`	`str \| None`	The name of the queue to filter items by.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the list of queue items.

list_items_async `async` ¶

list_items_async(
    queue_name=None, *, folder_key=None, folder_path=None
)

Asynchronously retrieves a list of queue items from the Orchestrator.

Parameters:

Name	Type	Description	Default
`queue_name`	`str \| None`	The name of the queue to filter items by.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response containing the list of queue items.

update_progress_of_transaction_item ¶

update_progress_of_transaction_item(
    transaction_key,
    progress,
    queue_name=None,
    *,
    folder_key=None,
    folder_path=None,
)

Updates the progress of a transaction item.

Parameters:

Name	Type	Description	Default
`transaction_key`	`str`	Unique identifier of the transaction.	required
`progress`	`str`	Progress message to set.	required
`queue_name`	`str \| None`	The name of the queue the transaction belongs to.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response confirming the progress update.

Related Activity: Set Transaction Progress

update_progress_of_transaction_item_async `async` ¶

update_progress_of_transaction_item_async(
    transaction_key,
    progress,
    queue_name=None,
    *,
    folder_key=None,
    folder_path=None,
)

Asynchronously updates the progress of a transaction item.

Parameters:

Name	Type	Description	Default
`transaction_key`	`str`	Unique identifier of the transaction.	required
`progress`	`str`	Progress message to set.	required
`queue_name`	`str \| None`	The name of the queue the transaction belongs to.	`None`
`folder_key`	`str \| None`	The key of the folder. Overrides the default one set in the SDK config.	`None`
`folder_path`	`str \| None`	The path of the folder. Overrides the default one set in the SDK config.	`None`

Returns:

Name	Type	Description
`Response`	`Response`	HTTP response confirming the progress update.

Related Activity: Set Transaction Progress

Queues

QueuesService ¶

complete_transaction_item ¶

complete_transaction_item_async async ¶

create_item ¶

create_item_async async ¶

create_items ¶

create_items_async async ¶

create_transaction_item ¶

create_transaction_item_async async ¶

list_items ¶

list_items_async async ¶

update_progress_of_transaction_item ¶

update_progress_of_transaction_item_async async ¶

complete_transaction_item_async `async` ¶

create_item_async `async` ¶

create_items_async `async` ¶

create_transaction_item_async `async` ¶

list_items_async `async` ¶

update_progress_of_transaction_item_async `async` ¶