calendarrule EntityType
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Defines free/busy times for a service and for resources or resource groups, such as working, non-working, vacation, and blocked.
Entity Set path:[organization URI]/api/data/v8.2/calendarrules
Base Type: crmbaseentity EntityType
Display Name: Calendar Rule
Primary Key: calendarruleid
Primary Name Attribute: name
Properties
Lookup Properties
Single-valued navigation properties
The calendarrule entity type has no collection-valued navigation properties.
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name |
Type |
Details |
|---|---|---|
businessunitid |
Edm.Guid |
Description: Unique identifier of the business unit with which the calendar rule is associated. Display Name: Business Unit Read-only property |
calendarruleid |
Edm.Guid |
Description: Unique identifier of the calendar rule. Display Name: Calendar Rule |
createdon |
Edm.DateTimeOffset |
Description: Date and time when the calendar rule was created. Display Name: Created On Read-only property |
description |
Edm.String |
Description: Defines free/busy times for a service and for resources or resource groups, such as working, non-working, vacation, and blocked. Display Name: Description |
duration |
Edm.Int32 |
Description: Duration of the calendar rule in minutes. Display Name: Duration |
effectiveintervalend |
Edm.DateTimeOffset |
Description: Effective interval end of the calendar rule. Display Name: Effective Interval End |
effectiveintervalstart |
Edm.DateTimeOffset |
Description: Effective interval start of the calendar rule. Display Name: Effective Interval Start |
effort |
Edm.Double |
Description: Effort available for a resource during the time described by the calendar rule. Display Name: Effort |
endtime |
Edm.DateTimeOffset |
Description: For internal use only. Display Name: End |
extentcode |
Edm.Int32 |
Description: Extent of the calendar rule. Display Name: Extent Code |
groupdesignator |
Edm.String |
Description: Unique identifier of the group. Display Name: Group Designator |
ismodified |
Edm.Boolean |
Description: For internal use only. Default Options: 1 : Yes Display Name: Is Modified |
isselected |
Edm.Boolean |
Description: Flag used in vary-by-day calendar rules. Default Options: 1 : Yes Display Name: Is Selected |
issimple |
Edm.Boolean |
Description: Flag used in vary-by-day calendar rules. Default Options: 1 : Yes Display Name: Is Simple |
isvaried |
Edm.Boolean |
Description: Flag used in leaf nonrecurring rules. Default Options: 1 : Yes Display Name: Is Varied |
modifiedon |
Edm.DateTimeOffset |
Description: Date and time when the calendar rule was last modified. Display Name: Modified On Read-only property |
name |
Edm.String |
Description: Name of the calendar rule. Display Name: Name |
offset |
Edm.Int32 |
Description: Start offset for leaf nonrecurring rules. Display Name: Offset |
organizationid |
Edm.Guid |
Description: Unique identifier of the organization with which the calendar rule is associated. Display Name: Organization Read-only property |
pattern |
Edm.String |
Description: Pattern of the rule recurrence. Display Name: Recurrence Pattern |
rank |
Edm.Int32 |
Description: Rank of the calendar rule. Display Name: Rank |
starttime |
Edm.DateTimeOffset |
Description: Start time for the rule. Display Name: Start |
subcode |
Edm.Int32 |
Description: Sub-type of calendar rule. Display Name: Sub Code |
timecode |
Edm.Int32 |
Description: Type of calendar rule such as working hours, break, holiday, or time off. Display Name: Type |
timezonecode |
Edm.Int32 |
Description: Local time zone for the calendar rule. Display Name: Time Zone |
versionnumber |
Edm.Int64 |
Description: Read-only property |
Lookup Properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties
Name |
Single-valued navigation property |
Description |
|---|---|---|
_calendarid_value |
calendarid |
Unique identifier of the calendar with which the calendar rule is associated. |
_createdby_value |
createdby |
Unique identifier of the user who created the calendar rule. |
_createdonbehalfby_value |
createdonbehalfby |
Unique identifier of the delegate user who created the calendarrule. |
_innercalendarid_value |
innercalendarid |
Unique identifier of the inner calendar for non-leaf calendar rules. |
_modifiedby_value |
modifiedby |
Unique identifier of the user who last modified the calendar rule. |
_modifiedonbehalfby_value |
modifiedonbehalfby |
Unique identifier of the delegate user who last modified the calendarrule. |
_serviceid_value |
serviceid |
Unique identifier of the service with which the calendar rule is associated. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
Name |
Type |
Partner |
|---|---|---|
calendarid |
calendar_calendar_rules |
|
createdby |
lk_calendarrule_createdby |
|
createdonbehalfby |
lk_calendarrule_createdonbehalfby |
|
innercalendarid |
inner_calendar_calendar_rules |
|
modifiedby |
lk_calendarrule_modifiedby |
|
modifiedonbehalfby |
lk_calendarrule_modifiedonbehalfby |
|
serviceid |
service_calendar_rules |
See Also
Use the Microsoft Dynamics 365 Web API
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 365
© 2016 Microsoft. All rights reserved. Copyright