bulkdeleteoperation EntityType
User-submitted bulk deletion job.
- Entity set path:
- [organization URI]/api/data/v9.2/bulkdeleteoperations
- Base type:
- crmbaseentity
- Display name:
- Bulk Delete Operation
- Primary key:
- bulkdeleteoperationid
- Primary name column:
- name
- Operations supported:
- GET DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bulkdeleteoperationid | Edm.Guid |
Unique identifier of the bulk deletion job. Display name: Bulk Deletion Job Read only
|
||||||||||||||||||||||
| childrecordsdeletedbreakdown | Edm.String |
Per-entity breakdown (JSON) of the child records deleted through cascade as part of the bulk delete operation. Display name: Cascade Deleted Child Records Breakdown |
||||||||||||||||||||||
| childrecordsdeletedcount | Edm.Int32 |
Total number of child records deleted through cascade as part of the bulk delete operation. Display name: No. of Cascade Deleted Child Records |
||||||||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the bulk deletion job was created. Display name: Created On Read only
|
||||||||||||||||||||||
| failurecount | Edm.Int32 |
Number of records that could not be deleted by the bulk deletion job. Display name: Failures Read only
|
||||||||||||||||||||||
| isrecurring | Edm.Boolean |
Information about if recurrence is defined for the bulk deletion job. Display name: Is Recurring Read only
Default options
|
||||||||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the bulk deletion job record was last modified. Display name: Modified On Read only
|
||||||||||||||||||||||
| name | Edm.String |
Name of the bulk deletion job. Display name: System Job Name Read only
|
||||||||||||||||||||||
| nextrun | Edm.DateTimeOffset |
Next scheduled time for the bulk deletion job to run. Display name: Next Run Read only
|
||||||||||||||||||||||
| orderedquerysetxml | Edm.String |
Fetch XML of the ordered query set. Read only
|
||||||||||||||||||||||
| parentbulkdeletepolicyid | Edm.String |
BulkDeleteOperationId of the parent (recurring) bulk delete policy that this run instance belongs to. Null for one-shot jobs and recurring policies. Display name: Parent Bulk Delete Policy |
||||||||||||||||||||||
| processingqeindex | Edm.Int32 |
Index of the ordered query expression that defines the deletion set. Display name: Query Index Read only
|
||||||||||||||||||||||
| statecode | Edm.Int32 |
Status of the bulk deletion job. Display name: Status Read only
Default options
|
||||||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the bulk deletion job. Display name: Status Reason Read only
Default options
|
||||||||||||||||||||||
| successcount | Edm.Int32 |
Number of records deleted by the bulk deletion job. Display name: Deleted Read only
|
||||||||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. |
||||||||||||||||||||||
| totalsizecleanedupinbytes | Edm.Int64 |
Total size in bytes reclaimed by deleting the records and their cascaded child records as part of the bulk delete operation. Backed by SQL bigint to hold byte counts well beyond 5 TB (int caps at ~2 GB). Display name: Total Size Cleaned Up (Bytes) |
||||||||||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. |
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _asyncoperationid_value | asyncoperationid |
Unique identifier of the system job that created this record |
| _createdby_value | createdby |
Unique identifier of the user who created the bulk deletion job. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the bulkdeleteoperation. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the bulk deletion job. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the bulkdeleteoperation. |
| _owningbusinessunit_value | owningbusinessunit |
Business unit that owns the bulk deletion job. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| asyncoperationid | asyncoperation | AsyncOperation_BulkDeleteOperation |
| createdby | systemuser | lk_bulkdeleteoperationbase_createdby |
| createdonbehalfby | systemuser | lk_bulkdeleteoperation_createdonbehalfby |
| modifiedby | systemuser | lk_bulkdeleteoperationbase_modifiedby |
| modifiedonbehalfby | systemuser | lk_bulkdeleteoperation_modifiedonbehalfby |
| owningbusinessunit | businessunit | BulkDeleteOperation_BusinessUnit |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| BulkDeleteOperation_BulkDeleteFailure | bulkdeletefailure | bulkdeleteoperationid |