Calendar entity messages and methods

 

Updated: November 29, 2016

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

A calendar consists of a set of ordered rules that define time blocks of free/busy times for users, business units, and services, and for resources or resource groups. Examples of rules are working and nonworking hours, vacations, appointments, and weekly meetings. Calendars support recurring events and can be nested. In addition to time blocks, a calendar also specifies the capacity rules, as measured by the effort that is required for a specific resource and appointment type, and by the effort that is available per duration by a resource in the calendar for the resource. The schema name for this entity is Calendar. 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 following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

AssociateRequest

Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the Calendar entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

CreateRequest

Creates a calendar. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a calendar. You can also call the IOrganizationService.Delete method.

DisassociateRequest

Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the Calendar entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

ExpandCalendarRequest

Converts the calendar rules to an array of available time blocks for the specified period.

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 calendar. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

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

UpdateRequest

Updates a calendar. You can also call the IOrganizationService.Update method.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: