CRUDExtentions.DeleteEntity Method

Definition

Deletes an entity from the Dataverse

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

Parameters

serviceClient
ServiceClient

ServiceClient

entityType
String

entity type name

entityId
Guid

entity id

batchId
Guid

Optional : Batch ID to attach this request too.

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, false on failure

Applies to