Partilhar via

campaignactivity EntityType

  • Artigo

Description: Task performed, or to be performed, by a user for planning or running a campaign.

Entity Set path: [organization URI]/api/data/v8.0/campaignactivities

Base Type: activitypointer EntityType

Display Name: Campaign Activity

Primary Key: activityid

Primary Name Attribute: subject

Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to campaignactivity

Operations using the campaignactivity entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are not writable.

Name Type Details

_createdby_value

Edm.Guid

Description: Unique identifier of the user who created the activity.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_createdonbehalfby_value

Edm.Guid

Description: Unique identifier of the delegate user who created the activitypointer.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_modifiedby_value

Edm.Guid

Description: Unique identifier of user who last modified the activity.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_modifiedonbehalfby_value

Edm.Guid

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

Computed property

Read-only property

Inherited from: activitypointer EntityType

_ownerid_value

Edm.Guid

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

Inherited from: activitypointer EntityType

_owningbusinessunit_value

Edm.Guid

Description: Unique identifier of the business unit that owns the activity.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_owningteam_value

Edm.Guid

Description: Unique identifier of the team that owns the activity.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_owninguser_value

Edm.Guid

Description: Unique identifier of the user that owns the activity.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_regardingobjectid_value

Edm.Guid

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

Computed property

Read-only property

Inherited from: activitypointer EntityType

_sendermailboxid_value

Edm.Guid

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

Computed property

Read-only property

Inherited from: activitypointer EntityType

_serviceid_value

Edm.Guid

Description: Unique identifier of an associated service.

Computed property

Read-only property

Inherited from: activitypointer EntityType

_transactioncurrencyid_value

Edm.Guid

Description: Unique identifier of the currency associated with the activitypointer.

Computed property

Read-only property

Inherited from: activitypointer EntityType

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: Campaign Activity

Inherited from: activitypointer EntityType

activitytypecode

Edm.String

Description: Type of activity.

Display Name: Activity Type

Read-only property

Inherited from: activitypointer EntityType

actualcost

Edm.Decimal

Description: Type the actual cost of the campaign activity. The value entered is rolled up to the related campaign in the total cost calculations.

Display Name: Actual Cost

actualcost_base

Edm.Decimal

Description: Shows the Actual Cost field converted to the system's default base currency for reporting purposes. The calculations use the exchange rate specified in the Currencies area.

Display Name: Actual Cost (Base)

Read-only property

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

budgetedcost

Edm.Decimal

Description: Type the allocated budget of the campaign activity for estimated versus actual cost reporting.

Display Name: Budget Allocated

budgetedcost_base

Edm.Decimal

Description: Shows the Budget Allocated field converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.

Display Name: Budget Allocated (Base)

Read-only property

category

Edm.String

Description: Type a category to identify the campaign activity type, such as new business development or customer retention, to tie the campaign activity to a business group or function.

Display Name: Category

channeltypecode

Edm.Int32

Description: Select how communications for this activity will be sent, such as phone, letter, fax, or email.

Default Options:

1 : Phone
2 : Appointment
3 : Letter
4 : Letter via Mail Merge
5 : Fax
6 : Fax via Mail Merge
7 : Email
8 : Email via Mail Merge
9 : Other

Display Name: Channel

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

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

donotsendonoptout

Edm.Boolean

Description: Select whether to override the opt-out settings on leads, contacts, and accounts for the members of the target marketing lists of the campaign activity. If No is selected, marketing materials will be sent to members who have opted out.

Default Options:

1 : Yes
0 : No

Display Name: Exclude Members Who Opt Out

exchangerate

Edm.Decimal

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

Display Name: Exchange Rate

Read-only property

Inherited from: activitypointer EntityType

excludeifcontactedinxdays

Edm.Int32

Description: Type the minimum number of days that must be passed before a marketing list member can be contacted in a campaign again. The campaign activity will not be applied to members contacted within the specified time period.

Display Name: No. of Days

ignoreinactivelistmembers

Edm.Boolean

Description: Select whether inactive marketing list members will be excluded from the campaign activity distribution.

Default Options:

1 : Yes
0 : No

Display Name: Ignore Inactive Marketing List Members

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

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

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

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

postponeactivityprocessinguntil

Edm.DateTimeOffset

Description: For internal use only.

Read-only property

Inherited from: activitypointer EntityType

prioritycode

Edm.Int32

Description: Priority of the activity.

Default Options:

0 : Low
1 : Normal
2 : High

Display Name: Priority

Inherited from: activitypointer EntityType

processid

Edm.Guid

Description: Unique identifier of the Process.

Display Name: 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: Scheduled End

Inherited from: activitypointer EntityType

scheduledstart

Edm.DateTimeOffset

Description: Scheduled start time of the activity.

Display Name: Scheduled Start

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

stageid

Edm.Guid

Description: Unique identifier of the Stage.

Display Name: Process 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 : Proposed
0 : In Progress
2 : Closed
3 : Canceled
4 : Pending
5 : System Aborted
6 : Completed

Display Name: Status Reason

Inherited from: activitypointer EntityType

subcategory

Edm.String

Description: Type a subcategory to identify the campaign activity type and relate the activity to a specific product, sales region, business group, or other function.

Display Name: Sub-Category

subject

Edm.String

Description: Subject associated with the activity.

Display Name: Subject

Inherited from: activitypointer EntityType

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.

Display Name: Traversed Path

Inherited from: activitypointer EntityType

typecode

Edm.Int32

Description: Select the type of campaign activity to indicate the purpose of the activity.

Default Options:

1 : Research
2 : Content Preparation
3 : Target Marketing List Creation
4 : Lead Qualification
5 : Content Distribution
6 : Direct Initial Contact
7 : Direct Follow-Up Contact
8 : Reminder Distribution

Display Name: Type

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

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced.

Name Type Partner

activityid_activitypointer

activitypointer EntityType

activity_pointer_campaignactivity

createdby

systemuser EntityType

lk_activitypointer_createdby

createdby_campaignactivity

systemuser EntityType

lk_campaignactivity_createdby

createdonbehalfby

systemuser EntityType

lk_activitypointer_createdonbehalfby

createdonbehalfby_campaignactivity

systemuser EntityType

lk_campaignactivity_createdonbehalfby

modifiedby

systemuser EntityType

lk_activitypointer_modifiedby

modifiedby_campaignactivity

systemuser EntityType

lk_campaignactivity_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_activitypointer_modifiedonbehalfby

modifiedonbehalfby_campaignactivity

systemuser EntityType

lk_campaignactivity_modifiedonbehalfby

ownerid

principal EntityType

owner_activitypointers

owningbusinessunit

businessunit EntityType

business_unit_activitypointer

owningbusinessunit_campaignactivity

businessunit EntityType

business_unit_campaignactivity_activities

owningteam

team EntityType

team_activity

owningteam_campaignactivity

team EntityType

team_campaignactivity

owninguser

systemuser EntityType

user_activity

owninguser_campaignactivity

systemuser EntityType

user_campaignactivity

regardingobjectid_account

account EntityType

Account_ActivityPointers

regardingobjectid_bulkoperation

bulkoperation EntityType

BulkOperation_ActivityPointers

regardingobjectid_campaign

campaign EntityType

Campaign_ActivityPointers

regardingobjectid_campaign_campaignactivity

campaign EntityType

Campaign_CampaignActivities

regardingobjectid_campaignactivity

campaignactivity EntityType

CampaignActivity_ActivityPointers

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_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

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_ActivityPointer

transactioncurrencyid_campaignactivity

transactioncurrency EntityType

transactioncurrency_campaignactivity

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

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

campaignactivity_activity_parties

activityparty EntityType

activityid_campaignactivity

campaignactivity_activityparties

activityparty EntityType

partyid_campaignactivity

CampaignActivity_ActivityPointers

activitypointer EntityType

regardingobjectid_campaignactivity

CampaignActivity_Annotation

annotation EntityType

objectid_campaignactivity

CampaignActivity_Appointments

appointment EntityType

regardingobjectid_campaignactivity_appointment

CampaignActivity_AsyncOperations

asyncoperation EntityType

regardingobjectid_campaignactivity

CampaignActivity_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_campaignactivity

CampaignActivity_BulkOperations

bulkoperation EntityType

regardingobjectid_campaignactivity_bulkoperation

campaignactivity_connections1

connection EntityType

record1id_campaignactivity

campaignactivity_connections2

connection EntityType

record2id_campaignactivity

CampaignActivity_Emails

email EntityType

regardingobjectid_campaignactivity_email

CampaignActivity_Faxes

fax EntityType

regardingobjectid_campaignactivity_fax

CampaignActivity_Letters

letter EntityType

regardingobjectid_campaignactivity_letter

CampaignActivity_Phonecalls

phonecall EntityType

regardingobjectid_campaignactivity_phonecall

CampaignActivity_QueueItem

queueitem EntityType

objectid_campaignactivity

CampaignActivity_RecurringAppointmentMasters

recurringappointmentmaster EntityType

regardingobjectid_campaignactivity_recurringappointmentmaster

CampaignActivity_Tasks

task EntityType

regardingobjectid_campaignactivity_task

campaignactivitylist_association

list EntityType

campaignactivitylist_association

campaignactivitysalesliterature_association

salesliterature EntityType

campaignactivitysalesliterature_association

CreatedActivity_BulkOperationLogs

bulkoperationlog EntityType

createdobjectid_activitypointer

Operations bound to campaignactivity

The following operations are bound to the campaignactivity entity type.

Name Bound to

DistributeCampaignActivity Action

Entity

Operations using the campaignactivity entity type.

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

Name How used Description

AddItemCampaignActivity Action

CampaignActivity Parameter

Adds an item to a campaign activity.

DistributeCampaignActivity Action

entity Parameter

Creates a bulk operation that distributes a campaign activity.

Consulte também

Outros recursos

Web API Action 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 CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.