Share via


BulkDelete Action

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Submits a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities.

This Web API action corresponds to the organization service BulkDeleteRequest.

BulkDelete action is not bound to any entity types.

Parameters

Parameters allow for data to be passed to the action.

Name

Type

Nullable

Unicode

Description

QuerySet

Collection(QueryExpression ComplexType)

An array of queries for a bulk delete job

JobName

Edm.String

false

false

The name of an asynchronous bulk delete job

SendEmailNotification

Edm.Boolean

false

Indicates whether an email notification is sent after the bulk delete job has finished running

ToRecipients

Collection(activityparty EntityType)

false

An array of IDs for the system users (users) who are listed in the To box of an email notification.

CCRecipients

Collection(activityparty EntityType)

false

An array of IDs for the system users (users) who are listed in the Cc box of the email notification.

RecurrencePattern

Edm.String

false

false

The recurrence pattern for the bulk delete job

StartDateTime

Edm.DateTimeOffset

false

The start date and time to run a bulk delete job

SourceImportId

Edm.Guid

The ID of the data import job

RunNow

Edm.Boolean

TODO: BulkDelete Action RunNow Parameter Description

Return Type

The BulkDelete action returns the following value.

Type

Nullable

Description

BulkDeleteResponse ComplexType

false

Contains the response from the BulkDelete Action.

See Also

Use Web API actions
Web API EntityType Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright