ApplyRecordCreationAndUpdateRuleRequest Class

Article
11/28/2016

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

Contains data to apply record creation and update rules to activities in CRM created as a result of the integration with external applications.

For the Web API use the ApplyRecordCreationAndUpdateRule Action.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.ApplyRecordCreationAndUpdateRuleRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ApplyRecordCreationAndUpdateRuleRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ApplyRecordCreationAndUpdateRuleRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	ApplyRecordCreationAndUpdateRuleRequest()	Initializes a new instance of the ApplyRecordCreationAndUpdateRuleRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	Target	Gets or sets the target for applying the rule.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the ApplyRecordCreationAndUpdateRuleResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the activity, QueueItem and Workflow entities, and access rights on the specified record in the Target property. For a complete list of the required privileges, see ApplyRecordCreationAndUpdateRule message privileges.

Notes to Callers

The record creation and update rules in CRM enable you to automatically convert incoming activities, such as emails, custom activities, and posts, from external integrated applications (mobile applications, portals or social channels) to system or custom records in CRM. These rules can be created or edited using the web client or Microsoft Dynamics CRM for Outlook only; rule creation and update is not supported through SDK. More information: Help & Training: Automatically create records in CRM

Use the ApplyRecordCreationAndUpdateRuleRequest message to retroactively apply a record creation and update rule to the activity that got created in CRM while the rule was inactive. To edit a rule, you need to deactivate the rule, edit the rule definition, and then reactivate the rule. While the rule is in inactive stage because its being edited, the activities from the external applications will continue to come into CRM (if you have configured an external application to integrate with CRM), but will not be acted upon as the rule is not active.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via