Share via


GeneralExtensions.AddEntityToQueue Method

Definition

This will route a Entity to a public queue,

public static bool AddEntityToQueue (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, Guid entityId, string entityName, string queueName, Guid workingUserId, bool setWorkingByUser = false, Guid batchId = default, bool bypassPluginExecution = false);
static member AddEntityToQueue : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * Guid * string * string * Guid * bool * Guid * bool -> bool
<Extension()>
Public Function AddEntityToQueue (serviceClient As ServiceClient, entityId As Guid, entityName As String, queueName As String, workingUserId As Guid, Optional setWorkingByUser As Boolean = false, Optional batchId As Guid = Nothing, Optional bypassPluginExecution As Boolean = false) As Boolean

Parameters

serviceClient
ServiceClient

ServiceClient

entityId
Guid

ID of the Entity to route

entityName
String

Name of the Entity that the Id describes

queueName
String

Name of the Queue to Route Too

workingUserId
Guid

ID of the user id to set as the working system user

setWorkingByUser
Boolean

if true Set the worked by when doing the assign

batchId
Guid

Optional: if set to a valid GUID, generated by the Create Batch Request Method, will assigned the request to the batch for later execution, on fail, runs the request immediately

bypassPluginExecution
Boolean

Adds the bypass plugin behavior to this request. Note: this will only apply if the caller has the prvBypassPlugins permission to bypass plugins. If its attempted without the permission the request will fault.

Returns

true on success

Applies to