BulkDeleteOperation Entity Reference

User-submitted bulk deletion job.

Messages

Message Web API Operation SDK Assembly
Delete DELETE [org URI]/api/data/v9.0/bulkdeleteoperations(bulkdeleteoperationid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/bulkdeleteoperations(bulkdeleteoperationid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/bulkdeleteoperations
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Entity Properties

Property Value
CollectionSchemaName BulkDeleteOperations
DisplayCollectionName Bulk Delete Operations
DisplayName Bulk Delete Operation
EntitySetName bulkdeleteoperations
IsBPFEntity False
LogicalCollectionName bulkdeleteoperations
LogicalName bulkdeleteoperation
OwnershipType None
PrimaryIdAttribute bulkdeleteoperationid
PrimaryNameAttribute name
SchemaName BulkDeleteOperation

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

AsyncOperationId

Property Value
Description Unique identifier of the system job that created this record
DisplayName System Job
IsValidForForm False
IsValidForRead True
LogicalName asyncoperationid
RequiredLevel None
Targets asyncoperation
Type Lookup

BulkDeleteOperationId

Property Value
Description Unique identifier of the bulk deletion job.
DisplayName Bulk Deletion Job
IsValidForForm False
IsValidForRead True
LogicalName bulkdeleteoperationid
RequiredLevel SystemRequired
Type Uniqueidentifier

CreatedBy

Property Value
Description Unique identifier of the user who created the bulk deletion job.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the bulk deletion job was created.
DisplayName
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel SystemRequired
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the bulkdeleteoperation.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

FailureCount

Property Value
Description Number of records that could not be deleted by the bulk deletion job.
DisplayName Failures
Format None
IsValidForForm True
IsValidForRead True
LogicalName failurecount
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

IsRecurring

Property Value
Description Information about if recurrence is defined for the bulk deletion job.
DisplayName Is Recurring
IsValidForForm True
IsValidForRead True
LogicalName isrecurring
RequiredLevel SystemRequired
Type Boolean

IsRecurring Options

Value Label
1 Yes
0 No

DefaultValue: False

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the bulk deletion job.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the bulk deletion job record was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the bulkdeleteoperation.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

Name

Property Value
Description Name of the bulk deletion job.
DisplayName System Job Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 256
RequiredLevel None
Type String

NextRun

Property Value
DateTimeBehavior UserLocal
Description Next scheduled time for the bulk deletion job to run.
DisplayName Next Run
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName nextrun
RequiredLevel None
Type DateTime

OrderedQuerySetXml

Property Value
Description Fetch XML of the ordered query set.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName orderedquerysetxml
MaxLength 1073741823
RequiredLevel None
Type String

OwnerId

Property Value
Description Unique identifier of the user or team who owns the bulk delete operation.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwningBusinessUnit

Property Value
Description Business unit that owns the bulk deletion job.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningUser

Property Value
Description Business user what owns the bulk delete operation.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ProcessingQEIndex

Property Value
Description Index of the ordered query expression that defines the deletion set.
DisplayName Query Index
Format None
IsValidForForm False
IsValidForRead True
LogicalName processingqeindex
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

StateCode

Property Value
Description Status of the bulk deletion job.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Ready 1 Ready
1 Suspended 2 Suspended
2 Locked 2 Locked
3 Completed 2 Completed

StatusCode

Property Value
Description Reason for the status of the bulk deletion job.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
0 Waiting For Resources 0
10 Waiting 1
11 Retrying 1
12 Paused 1
20 In Progress 2
21 Pausing 2
22 Canceling 2
30 Succeeded 3
31 Failed 3
32 Canceled 3

SuccessCount

Property Value
Description Number of records deleted by the bulk deletion job.
DisplayName Deleted
Format None
IsValidForForm True
IsValidForRead True
LogicalName successcount
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

One-To-Many Relationships

Listed by SchemaName.

BulkDeleteOperation_BulkDeleteFailure

Same as bulkdeletefailure entity BulkDeleteOperation_BulkDeleteFailure Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute bulkdeleteoperationid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName BulkDeleteOperation_BulkDeleteFailure
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_bulkdeleteoperationbase_modifiedby

See systemuser Entity lk_bulkdeleteoperationbase_modifiedby One-To-Many relationship.

AsyncOperation_BulkDeleteOperation

See asyncoperation Entity AsyncOperation_BulkDeleteOperation One-To-Many relationship.

lk_bulkdeleteoperation_createdonbehalfby

See systemuser Entity lk_bulkdeleteoperation_createdonbehalfby One-To-Many relationship.

lk_bulkdeleteoperation_modifiedonbehalfby

See systemuser Entity lk_bulkdeleteoperation_modifiedonbehalfby One-To-Many relationship.

lk_bulkdeleteoperationbase_createdby

See systemuser Entity lk_bulkdeleteoperationbase_createdby One-To-Many relationship.

BulkDeleteOperation_BusinessUnit

See businessunit Entity BulkDeleteOperation_BusinessUnit One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
bulkdeleteoperation EntityType