RecurrenceRule entity messages and methods

 

Updated: November 29, 2016

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

A recurrence rule represents the pattern of incidence for a recurring appointment. The schema name for this entity is RecurrenceRule. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The recurrence rule entity offers limited functionality in terms of create, retrieve, update, and delete operations on this entity. You can’t directly update or delete recurrence rule records that were created as a result of creating recurring appointment master records. When you update the recurrence information of a recurring appointment or delete a recurring appointment master record, the associated recurrence rule record is automatically updated or deleted. To work with recurring appointments, use the recurring appointment master entity. More information: Recurring appointment entities.

The RecurrenceRule.MonthOfYear attribute specifies the month of the year valid for the recurrence pattern. The possible values for this attribute are defined in the MonthOfYear (recurrencerule_monthofyear) option set.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

CreateRequest

Creates a recurrence rule. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a recurrence rule. You can also call the IOrganizationService.Delete method.

InitializeFromRequest

Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.

RetrieveDuplicatesRequest

Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.

RetrieveRequest

Retrieves a recurrence rule. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of recurrence rules. You can also call the IOrganizationService.RetrieveMultiple method.

UpdateRequest

Updates a recurrence rule. You can also call the IOrganizationService.Update method.

ValidateRecurrenceRuleRequest

Validates a rule for a recurring appointment.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Show: