UiPath Documentation
activities
latest
false
Workflow activities

DeleteQueueItems

Deletes items in any status except Deleted from a specified Orchestrator queue.

Enables you to delete items from a specified Orchestrator queue. Please note that in order to execute this method in Studio, the Robot has to be connected to Orchestrator and the Robot role needs Edit, Create, and Delete permissions on queues and Delete permissions on transactions. When this method is run, it uses the same authentication context as the Robot which executes it, inheriting its permissions.

The method deletes items in any queue item status except Deleted. It skips, without an error, items that are already deleted and items that changed in Orchestrator after you retrieved them. On Orchestrator 2023.10 and earlier, the method does not delete In Progress items and skips them without an error.

Deleting items with a status other than New, such as Failed, can affect related counts, insights, or data integrity. If you have concerns about this impact, UiPath Support can help assess it before you delete items in bulk.

Definition​

Namespace: UiPath.Activities.System.API

Assembly: UiPath.System.Activities.Api (in UiPath.System.Activities.Api.dll)

Overloads​

DeleteQueueItems(IEnumerable<QueueItem>)Enables you to delete items from a specified Orchestrator queue.
DeleteQueueItems(IEnumerable<QueueItem>, String)(Obsolete) Enables you to delete items from a specified Orchestrator queue, at a specified folder path.
DeleteQueueItems(IEnumerable<QueueItem>, String, Int32)(Obsolete) Enables you to delete items from a specified Orchestrator queue, at a specified folder path, and with TimeoutMS configured.
DeleteQueueItems(IEnumerable<QueueItem>, Int32)Enables you to delete items from a specified Orchestrator queue, and with TimeoutMS configured.

DeleteQueueItems(IEnumerable<QueueItem>)​

Enables you to delete items from a specified Orchestrator queue.

void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems
)
void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems
)

queueItems IEnumerable QueueItem : The list of items that you want to mark as deleted in Orchestrator. They can be in any status except Deleted and should be retrieved via a Get Queue Items method first.

DeleteQueueItems(IEnumerable<QueueItem>, String) (Obsolete)​

Enables you to delete items from a specified Orchestrator queue, at a specified folder path.

This overload is obsolete. The folderPath parameter is ignored, because the folder comes from the queue items, which must all belong to the same folder. The replacement is DeleteQueueItems(IEnumerable<QueueItem>).

void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems,
    string folderPath
)
void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems,
    string folderPath
)

queueItems IEnumerable QueueItem : The list of items that you want to mark as deleted in Orchestrator. They can be in any status except Deleted and should be retrieved via a Get Queue Items method first.

folderPath String : The path of the folder where the specified QueueItems are located, if different from the folder where the process is running. This supports only string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

DeleteQueueItems(IEnumerable<QueueItem>, String, Int32) (Obsolete)​

Enables you to delete items from a specified Orchestrator queue, at a specified folder path, and with TimeoutMS configured.

This overload is obsolete. The folderPath parameter is ignored, because the folder comes from the queue items, which must all belong to the same folder. The replacement is DeleteQueueItems(IEnumerable<QueueItem>, Int32).

void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems,
    string folderPath,
    int timeoutMS
)
void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems,
    string folderPath,
    int timeoutMS
)

queueItems IEnumerable QueueItem : The list of items that you want to mark as deleted in Orchestrator. They can be in any status except Deleted and should be retrieved via a Get Queue Items method first.

folderPath String : The path of the folder where the specified QueueItems are located, if different from the folder where the process is running. This supports only string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

timeoutMS Int32 : Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

DeleteQueueItems(IEnumerable<QueueItem>, Int32)​

Enables you to delete items from a specified Orchestrator queue, and with TimeoutMS configured.

void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems,
    int timeoutMS
)
void DeleteQueueItems(
    IEnumerable<QueueItem> queueItems,
    int timeoutMS
)

queueItems IEnumerable QueueItem : The list of items that you want to mark as deleted in Orchestrator. They can be in any status except Deleted and should be retrieved via a Get Queue Items method first. All items must belong to the same folder.

timeoutMS Int32 : Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated