PropagateByExpressionRequest PropagateByExpressionRequest PropagateByExpressionRequest PropagateByExpressionRequest Class

Definition

Contains the data that is needed to create a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.

For the Web API use thePropagateByExpression Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

public ref class PropagateByExpressionRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class PropagateByExpressionRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type PropagateByExpressionRequest = class
    inherit OrganizationRequest
Public NotInheritable Class PropagateByExpressionRequest
Inherits OrganizationRequest
Inheritance
PropagateByExpressionRequestPropagateByExpressionRequestPropagateByExpressionRequestPropagateByExpressionRequest
Attributes

Examples


      /// <summary>
/// This method creates a Quick Campaign for a set of accounts selected by a query
/// </summary>
/// <param name="activityEntity">
/// An object that indicates activity type for the quick campaign and 
/// contains values for each of activity that will be created
/// </param>
/// <param name="query">
/// A query that provides a list of accounts for which 
/// the quick campaign is distributed.
/// </param>
/// <param name="ownershipOption">
/// Specifies who will own the activities created by the Quick Campaign
/// The PropagationOwnershipOptions enum is used to specify value for this parameter
/// </param>
/// <param name="isPropagate">
/// Specifies whether the operation is to be executed. 
/// This input is often 'true' for Quick Campaign
/// </param>       
/// <returns></returns>
public Guid CreateAndRetrieveQuickCampaignForQueryExpression(Entity emailActivityEntity, 
    QueryExpression query, PropagationOwnershipOptions ownershipOption, bool isPropagate)
{

    // create the bulkoperation
    PropagateByExpressionRequest request = new PropagateByExpressionRequest() {
        Activity = emailActivityEntity,
        ExecuteImmediately = false, // Default value.
        FriendlyName = "Query Based Quick Campaign",
        OwnershipOptions = ownershipOption,
        QueryExpression = query,
        Owner = new EntityReference("systemuser", _currentUser),
        PostWorkflowEvent = true,
        SendEmail = false,
        TemplateId = Guid.Empty
    };

    PropagateByExpressionResponse response = 
        (PropagateByExpressionResponse)_serviceProxy.Execute(request);

    Guid bulkOpId = response.BulkOperationId;
    System.Console.WriteLine(
        "Quick Campaign with following name has been created. "
        + "Please verify in Web app manually: \n" 
        + request.FriendlyName + "\nPress enter to continue....");
    System.Console.ReadLine();
    return bulkOpId;

}

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

Marketing#QuickCampaign2 MarketingVB#QuickCampaign2

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the PropagateByExpressionResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Queue and Template entities, and on the specified entity in the Activity property. The caller must also have access rights on the specified records in the QueueId property and the TemplateId property. For a complete list of the required privileges, see PropagateByExpression message privileges.

Notes for Callers

This operation distributes activities that specify a recipient: phone call, appointment, letter, fax, or email.

Constructors

PropagateByExpressionRequest() PropagateByExpressionRequest() PropagateByExpressionRequest() PropagateByExpressionRequest()

Initializes a new instance of the PropagateByExpressionRequest class.

Properties

Activity Activity Activity Activity

Gets or sets the activity to be distributed. Required.

ExecuteImmediately ExecuteImmediately ExecuteImmediately ExecuteImmediately

Gets or sets a value that indicates whether the activity is both created and executed. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
FriendlyName FriendlyName FriendlyName FriendlyName

Gets or sets the user-identifiable name for the campaign. Required.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Owner Owner Owner Owner

Gets or sets the owner for the activity. Required.

OwnershipOptions OwnershipOptions OwnershipOptions OwnershipOptions

Gets or sets the ownership options for propagation. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
PostWorkflowEvent PostWorkflowEvent PostWorkflowEvent PostWorkflowEvent

Gets or sets a value that indicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. Required.

QueryExpression QueryExpression QueryExpression QueryExpression

Gets or sets the query criteria to select accounts, contacts, or leads for which activities are created. Required.

QueueId QueueId QueueId QueueId

Gets or sets the ID of the queue to which the created activities are added. Optional.

RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SendEmail SendEmail SendEmail SendEmail

Gets or sets a value that indicates whether to send an email about the new activity. Required.

TemplateId TemplateId TemplateId TemplateId

Gets or sets the ID of the email template. Required.

Applies to

See also