Queues
QueuesService
Bases: FolderContext, BaseService
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(transaction_key, result)
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
|
Union[Dict[str, Any], TransactionItemResult]
|
Result data for the transaction, either as a dictionary or TransactionItemResult instance. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response confirming the transaction completion. |
Related Activity: Set Transaction Status
complete_transaction_item_async(transaction_key, result)
async
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
|
Union[Dict[str, Any], TransactionItemResult]
|
Result data for the transaction, either as a dictionary or TransactionItemResult instance. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response confirming the transaction completion. |
Related Activity: Set Transaction Status
create_item(item)
Creates a new queue item in the Orchestrator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
item
|
Union[Dict[str, Any], QueueItem]
|
Queue item data, either as a dictionary or QueueItem instance. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the created queue item details. |
Related Activity: Add Queue Item
create_item_async(item)
async
Asynchronously creates a new queue item in the Orchestrator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
item
|
Union[Dict[str, Any], QueueItem]
|
Queue item data, either as a dictionary or QueueItem instance. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the created queue item details. |
Related Activity: Add Queue Item
create_items(items, queue_name, commit_type)
Creates multiple queue items in bulk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
items
|
List[Union[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 |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the bulk operation result. |
create_items_async(items, queue_name, commit_type)
async
Asynchronously creates multiple queue items in bulk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
items
|
List[Union[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 |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the bulk operation result. |
create_transaction_item(item, no_robot=False)
Creates a new transaction item in a queue.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
item
|
Union[Dict[str, Any], TransactionItem]
|
Transaction item data, either as a dictionary or TransactionItem instance. |
required |
no_robot
|
bool
|
If True, the transaction will not be associated with a robot. Defaults to False. |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the transaction item details. |
create_transaction_item_async(item, no_robot=False)
async
Asynchronously creates a new transaction item in a queue.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
item
|
Union[Dict[str, Any], TransactionItem]
|
Transaction item data, either as a dictionary or TransactionItem instance. |
required |
no_robot
|
bool
|
If True, the transaction will not be associated with a robot. Defaults to False. |
False
|
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the transaction item details. |
list_items()
Retrieves a list of queue items from the Orchestrator.
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the list of queue items. |
list_items_async()
async
Asynchronously retrieves a list of queue items from the Orchestrator.
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response containing the list of queue items. |
update_progress_of_transaction_item(transaction_key, progress)
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 |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response confirming the progress update. |
Related Activity: Set Transaction Progress
update_progress_of_transaction_item_async(transaction_key, progress)
async
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 |
Returns:
| Name | Type | Description |
|---|---|---|
Response |
Response
|
HTTP response confirming the progress update. |
Related Activity: Set Transaction Progress