GetQueueItem

Extension method of GetTransactionItem.

Note: In C#, you can call this method as an instance method on any object of type ISystemService. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

The method gets an item from the queue so that you can process it (start the transaction) and sets its status to In Progress.

Definition

Namespace: UiPath.Activities.System.API

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

Overloads

GetQueueItem(ISystemService, String)	Retrieves a list of transactions from a specified queue.
GetQueueItem(ISystemService, String, String)	Retrieves a list of transactions from a specified queue, and from a specific Orchestrator folder.
GetQueueItem(ISystemService, String, String, ReferenceFilterStrategy, String, Int32)	Retrieves a list of transactions from an indicated queue, according to multiple filters, such as creation date, priority, state and reference.

GetQueueItem(ISystemService, String)

Retrieves a list of transactions from a specified queue.

public static QueueItem GetQueueItem(
	this ISystemService system,
	string queueType
)

system ISystemService

queueType String

The queue where the TransactionItem object is to be added.

GetQueueItem(ISystemService, String, String)

Retrieves a list of transactions from a specified queue, and from a specific Orchestrator folder.

public static QueueItem GetQueueItem(
	this ISystemService system,
	string queueType,
	string folderPath
)

system ISystemService

queueType String

The queue where the TransactionItem object is to be added.

folderPath String

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

GetQueueItem(ISystemService, String, String, ReferenceFilterStrategy, String, Int32)

Retrieves a list of transactions from an indicated queue, according to multiple filters, such as creation date, priority, state and reference.

public static QueueItem GetQueueItem(
	this ISystemService system,
	string queueType,
	string folderPath,
	ReferenceFilterStrategy filterStrategy,
	string reference,
	int timeoutMS
)

system ISystemService

queueType String

The queue where the TransactionItem object is to be added.

folderPath String

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

filterStrategy ReferenceFilterStrategy

The strategy to employ when filtering items by reference.

reference String

Filters Orchestrator queue items by reference.

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).

Return value

QueueItem

The retrieved TransactionItem.