bulkoperation EntityType

Dynamics CRM 2016
 

Updated: November 29, 2016

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

Description: System operation used to perform lengthy and asynchronous operations on large data sets, such as distributing a campaign activity or quick campaign.

Entity Set path:[organization URI]/api/data/v8.2/bulkoperations

Base Type: activitypointer EntityType

Display Name: Quick Campaign

Primary Key: activityid

Primary Name Attribute: subject

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to bulkoperation

Operations using the bulkoperation entity type.

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

activityadditionalparams

Edm.String

Description: Additional information provided by the external application as JSON. For internal use only.

Inherited from: activitypointer EntityType

activityid

Edm.Guid

Description: Unique identifier of the activity.

Display Name: Activity

Inherited from: activitypointer EntityType

activitytypecode

Edm.String

Description: Type of activity.

Display Name: Activity Type

Read-only property

Inherited from: activitypointer EntityType

actualdurationminutes

Edm.Int32

Description: Actual duration of the activity in minutes.

Display Name: Actual Duration

Inherited from: activitypointer EntityType

actualend

Edm.DateTimeOffset

Description: Actual end time of the activity.

Display Name: Actual End

Inherited from: activitypointer EntityType

actualstart

Edm.DateTimeOffset

Description: Actual start time of the activity.

Display Name: Actual Start

Inherited from: activitypointer EntityType

bulkoperationnumber

Edm.String

Description: Shows the number for the quick campaign record, used to identify the quick campaign.

Display Name: Bulk Operation Number

Read-only property

community

Edm.Int32

Description: Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only.

Inherited from: activitypointer EntityType

createdon

Edm.DateTimeOffset

Description: Date and time when the activity was created.

Display Name: Created On

Read-only property

Inherited from: activitypointer EntityType

createdrecordtypecode

Edm.Int32

Description: Choose the activity to create that determines how target prospects or customers in this quick campaign are contacted.

Default Options:

1 : Phone Call
2 : Fax
3 : Letter
4 : Email
5 : Appointment
6 : Send Direct Email

Display Name: Activity Type

Read-only property

deliverylastattemptedon

Edm.DateTimeOffset

Description: Date and time when the delivery of the activity was last attempted.

Read-only property

Inherited from: activitypointer EntityType

deliveryprioritycode

Edm.Int32

Description: Priority of delivery of the activity to the email server.

Inherited from: activitypointer EntityType

description

Edm.String

Description: Description of the activity.

Display Name: Description

Inherited from: activitypointer EntityType

errornumber

Edm.Int32

Description: Shows the error code that is used to troubleshoot issues in the quick campaign.

Display Name: Error Number

Read-only property

exchangeitemid

Edm.String

Description: The message id of activity which is returned from Exchange Server.

Inherited from: activitypointer EntityType

exchangerate

Edm.Decimal

Description: Exchange rate for the currency associated with the activitypointer with respect to the base currency.

Read-only property

Inherited from: activitypointer EntityType

exchangeweblink

Edm.String

Description: Shows the web link of Activity of type email.

Inherited from: activitypointer EntityType

failurecount

Edm.Int32

Description: Number of records which failed in the bulk operation.

Display Name: No. of Failures

Read-only property

instancetypecode

Edm.Int32

Description: Type of instance of a recurring series.

Read-only property

Inherited from: activitypointer EntityType

isbilled

Edm.Boolean

Description: Information regarding whether the activity was billed as part of resolving a case.

Default Options:

1 : Yes
0 : No

Display Name: Is Billed

Inherited from: activitypointer EntityType

ismapiprivate

Edm.Boolean

Description: For internal use only.

Inherited from: activitypointer EntityType

isregularactivity

Edm.Boolean

Description: Information regarding whether the activity is a regular activity type or event type.

Default Options:

1 : Yes
0 : No

Display Name: Is Regular Activity

Read-only property

Inherited from: activitypointer EntityType

isworkflowcreated

Edm.Boolean

Description: Information regarding whether the activity was created from a workflow rule.

Default Options:

1 : Yes
0 : No

Display Name: Is Workflow Created

Inherited from: activitypointer EntityType

lastonholdtime

Edm.DateTimeOffset

Description: Contains the date and time stamp of the last on hold time.

Inherited from: activitypointer EntityType

leftvoicemail

Edm.Boolean

Description: Left the voice mail

Inherited from: activitypointer EntityType

modifiedon

Edm.DateTimeOffset

Description: Date and time when activity was last modified.

Display Name: Modified On

Read-only property

Inherited from: activitypointer EntityType

onholdtime

Edm.Int32

Description: Shows how long, in minutes, that the record was on hold.

Read-only property

Inherited from: activitypointer EntityType

operationtypecode

Edm.Int32

Description: Select the type of bulk operation process, such as quick campaign or campaign activity distribution.

Default Options:

1 : Create Opportunities
2 : Create Activities
3 : Send Direct Mail
4 : Distribute
5 : Execute
7 : Quick Campaign

Display Name: Operation

Read-only property

parameters

Edm.String

Description: XML string that contains the parameters to the bulk operation.

Display Name: Parameters

Read-only property

postponeactivityprocessinguntil

Edm.DateTimeOffset

Description: For internal use only.

Read-only property

Inherited from: activitypointer EntityType

prioritycode

Edm.Int32

Description: Priority of the activity.

Inherited from: activitypointer EntityType

processid

Edm.Guid

Description: Unique identifier of the Process.

Inherited from: activitypointer EntityType

scheduleddurationminutes

Edm.Int32

Description: Scheduled duration of the activity, specified in minutes.

Display Name: Scheduled Duration

Inherited from: activitypointer EntityType

scheduledend

Edm.DateTimeOffset

Description: Scheduled end time of the activity.

Display Name: Due Date

Inherited from: activitypointer EntityType

scheduledstart

Edm.DateTimeOffset

Description: Scheduled start time of the activity.

Display Name: Start Date

Inherited from: activitypointer EntityType

senton

Edm.DateTimeOffset

Description: Date and time when the activity was sent.

Read-only property

Inherited from: activitypointer EntityType

seriesid

Edm.Guid

Description: Uniqueidentifier specifying the id of recurring series of an instance.

Read-only property

Inherited from: activitypointer EntityType

sortdate

Edm.DateTimeOffset

Description: Shows the date and time by which the activities are sorted.

Inherited from: activitypointer EntityType

stageid

Edm.Guid

Description: Unique identifier of the Stage.

Inherited from: activitypointer EntityType

statecode

Edm.Int32

Description: Status of the activity.

Default Options:

0 : Open
1 : Closed
2 : Canceled

Display Name: Status

Inherited from: activitypointer EntityType

statuscode

Edm.Int32

Description: Reason for the status of the activity.

Default Options:

1 : Pending
2 : In Progress
3 : Aborted
4 : Completed
5 : Canceled

Display Name: Status Reason

Inherited from: activitypointer EntityType

subject

Edm.String

Description: Subject associated with the activity.

Display Name: Subject

Inherited from: activitypointer EntityType

successcount

Edm.Int32

Description: Number of records which succeeded in the bulk operation.

Display Name: No. of Successes

Read-only property

targetedrecordtypecode

Edm.Int32

Description: Select the type of records targeted in the quick campaign to identify the target audience.

Default Options:

1 : Account
2 : Contact
4 : Lead

Display Name: Members Type

Read-only property

targetmemberscount

Edm.Int32

Description: Number of members to target.

Display Name: Total Members

Read-only property

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

Inherited from: activitypointer EntityType

traversedpath

Edm.String

Description: For internal use only.

Inherited from: activitypointer EntityType

utcconversiontimezonecode

Edm.Int32

Description: Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

Inherited from: activitypointer EntityType

versionnumber

Edm.Int64

Description: Version number of the activity.

Display Name: Version Number

Read-only property

Inherited from: activitypointer EntityType

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 Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_createdby_value

Unique identifier of the user who created the activity.

_createdonbehalfby_value

Unique identifier of the delegate user who created the activitypointer.

_modifiedby_value

Unique identifier of user who last modified the activity.

_modifiedonbehalfby_value

Unique identifier of the delegate user who last modified the activitypointer.

_ownerid_value

Unique identifier of the user or team who owns the activity.

_owningbusinessunit_value

Unique identifier of the business unit that owns the activity.

_owningteam_value

Unique identifier of the team that owns the activity.

_owninguser_value

Unique identifier of the user that owns the activity.

_regardingobjectid_value

Unique identifier of the object with which the activity is associated.

_sendermailboxid_value

Unique identifier of the mailbox associated with the sender of the email message.

_serviceid_value

Unique identifier of an associated service.

_slaid_value

Choose the service level agreement (SLA) that you want to apply to the case record.

_slainvokedid_value

Last SLA that was applied to this case. This field is for internal use only.

_transactioncurrencyid_value

Unique identifier of the currency associated with the activitypointer.

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

activityid_activitypointer

activitypointer EntityType

activity_pointer_BulkOperation

createdby

systemuser EntityType

lk_activitypointer_createdby

createdby_bulkoperation

systemuser EntityType

lk_BulkOperation_createdby

createdonbehalfby

systemuser EntityType

lk_activitypointer_createdonbehalfby

createdonbehalfby_bulkoperation

systemuser EntityType

lk_BulkOperation_createdonbehalfby

modifiedby

systemuser EntityType

lk_activitypointer_modifiedby

modifiedby_bulkoperation

systemuser EntityType

lk_BulkOperation_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_activitypointer_modifiedonbehalfby

modifiedonbehalfby_bulkoperation

systemuser EntityType

lk_BulkOperation_modifiedonbehalfby

ownerid

principal EntityType

owner_activitypointers

owningbusinessunit

businessunit EntityType

business_unit_activitypointer

owningbusinessunit_bulkoperation

businessunit EntityType

business_unit_BulkOperation_activities

owningteam

team EntityType

team_activity

owningteam_bulkoperation

team EntityType

team_BulkOperation

owninguser

systemuser EntityType

user_activity

owninguser_bulkoperation

systemuser EntityType

user_BulkOperation

regardingobjectid_account

account EntityType

Account_ActivityPointers

regardingobjectid_bookableresourcebooking

bookableresourcebooking EntityType

bookableresourcebooking_ActivityPointers

regardingobjectid_bookableresourcebookingheader

bookableresourcebookingheader EntityType

bookableresourcebookingheader_ActivityPointers

regardingobjectid_bulkoperation

bulkoperation EntityType

BulkOperation_ActivityPointers

regardingobjectid_campaign

campaign EntityType

Campaign_ActivityPointers

regardingobjectid_campaignactivity

campaignactivity EntityType

CampaignActivity_ActivityPointers

regardingobjectid_campaignactivity_bulkoperation

campaignactivity EntityType

CampaignActivity_BulkOperations

regardingobjectid_contact

contact EntityType

Contact_ActivityPointers

regardingobjectid_contract

contract EntityType

Contract_ActivityPointers

regardingobjectid_entitlement

entitlement EntityType

entitlement_ActivityPointers

regardingobjectid_entitlementtemplate

entitlementtemplate EntityType

entitlementtemplate_ActivityPointers

regardingobjectid_incident

incident EntityType

Incident_ActivityPointers

regardingobjectid_invoice

invoice EntityType

Invoice_ActivityPointers

regardingobjectid_knowledgearticle

knowledgearticle EntityType

KnowledgeArticle_ActivityPointers

regardingobjectid_knowledgebaserecord

knowledgebaserecord EntityType

KnowledgeBaseRecord_ActivityPointers

regardingobjectid_lead

lead EntityType

Lead_ActivityPointers

regardingobjectid_list

list EntityType

List_BulkOperations

regardingobjectid_new_interactionforemail

interactionforemail EntityType

new_interactionforemail_ActivityPointers

regardingobjectid_opportunity

opportunity EntityType

Opportunity_ActivityPointers

regardingobjectid_quote

quote EntityType

Quote_ActivityPointers

regardingobjectid_salesorder

salesorder EntityType

SalesOrder_ActivityPointers

sendermailboxid

mailbox EntityType

activitypointer_sendermailboxid_mailbox

serviceid

service EntityType

service_activity_pointers

sla_activitypointer_sla

sla EntityType

manualsla_activitypointer

slainvokedid_activitypointer_sla

sla EntityType

sla_activitypointer

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_ActivityPointer

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

activity_campaignresponse

campaignresponse EntityType

originatingactivityid_activitypointer

activity_pointer_activity_mime_attachment

activitymimeattachment EntityType

objectid_activitypointer

activity_pointer_appointment

appointment EntityType

activityid_activitypointer

activity_pointer_BulkOperation

bulkoperation EntityType

activityid_activitypointer

activity_pointer_BulkOperation_logs

bulkoperationlog EntityType

bulkoperationid_activitypointer

activity_pointer_campaignactivity

campaignactivity EntityType

activityid_activitypointer

activity_pointer_campaignresponse

campaignresponse EntityType

activityid_activitypointer

activity_pointer_email

email EntityType

activityid_activitypointer

activity_pointer_fax

fax EntityType

activityid_activitypointer

activity_pointer_incident_resolution

incidentresolution EntityType

activityid_activitypointer

activity_pointer_letter

letter EntityType

activityid_activitypointer

activity_pointer_opportunity_close

opportunityclose EntityType

activityid_activitypointer

activity_pointer_order_close

orderclose EntityType

activityid_activitypointer

activity_pointer_phonecall

phonecall EntityType

activityid_activitypointer

activity_pointer_quote_close

quoteclose EntityType

activityid_activitypointer

activity_pointer_recurringappointmentmaster

recurringappointmentmaster EntityType

activityid_activitypointer

activity_pointer_service_appointment

serviceappointment EntityType

activityid_activitypointer

activity_pointer_socialactivity

socialactivity EntityType

activityid_activitypointer

activity_pointer_task

task EntityType

activityid_activitypointer

activitypointer_activity_parties

activityparty EntityType

activityid_activitypointer

ActivityPointer_AsyncOperations

asyncoperation EntityType

regardingobjectid_activitypointer

ActivityPointer_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_activitypointer

ActivityPointer_CampaignActivityItems

campaignactivityitem EntityType

campaignactivityid

activitypointer_connections1

connection EntityType

record1id_activitypointer

activitypointer_connections2

connection EntityType

record2id_activitypointer

ActivityPointer_QueueItem

queueitem EntityType

objectid_activitypointer

bulkoperation_activity_parties

activityparty EntityType

partyid_bulkoperation

BulkOperation_ActivityPointers

activitypointer EntityType

regardingobjectid_bulkoperation

BulkOperation_Appointment

appointment EntityType

regardingobjectid_bulkoperation_appointment

BulkOperation_AsyncOperations

asyncoperation EntityType

regardingobjectid_bulkoperation

BulkOperation_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_bulkoperation

BulkOperation_CampaignResponse

campaignresponse EntityType

regardingobjectid_bulkoperation_campaignresponse

BulkOperation_Email

email EntityType

regardingobjectid_bulkoperation_email

BulkOperation_Faxes

fax EntityType

regardingobjectid_bulkoperation_fax

BulkOperation_Letter

letter EntityType

regardingobjectid_bulkoperation_letter

BulkOperation_logs

bulkoperationlog EntityType

bulkoperationid

BulkOperation_Phonecall

phonecall EntityType

regardingobjectid_bulkoperation_phonecall

BulkOperation_QueueItem

queueitem EntityType

objectid_bulkoperation

BulkOperation_RecurringAppointmentMaster

recurringappointmentmaster EntityType

regardingobjectid_bulkoperation_recurringappointmentmaster

BulkOperation_SocialActivity

socialactivity EntityType

regardingobjectid_bulkoperation_socialactivity

BulkOperation_SyncErrors

syncerror EntityType

regardingobjectid_bulkoperation_syncerror

CreatedActivity_BulkOperationLogs

bulkoperationlog EntityType

createdobjectid_activitypointer

slakpiinstance_activitypointer

slakpiinstance EntityType

regarding_activitypointer

The following operations are bound to the bulkoperation entity type.

Name

Bound to

RetrieveMembersBulkOperation Function

Entity

The following operations use the bulkoperation entity type in a parameter or return type.

Name

How used

Description

DistributeCampaignActivity Action

ReturnType

Creates a bulk operation that distributes a campaign activity.

RetrieveMembersBulkOperation Function

entity Parameter

Retrieves the members of a bulk operation.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: