calendarrule EntityType

Defines free/busy times for a service and for resources or resource groups, such as working, non-working, vacation, and blocked.
Note: It is not possible to perform GET, POST, PATCH and DELETE operations with this entity.

Entity Set Path
[organization URI]/api/data/v9.0/calendarrules
Base Type
crmbaseentity
Display Name
Calendar Rule
Primary Key
calendarruleid
Primary Key Attribute
name

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
businessunitid Edm.Guid

Unique identifier of the business unit with which the calendar rule is associated.

Display Name: Business Unit

Read Only
calendarruleid Edm.Guid

Unique identifier of the calendar rule.

Display Name: Calendar Rule

createdon Edm.DateTimeOffset

Date and time when the calendar rule was created.

Display Name: Created On

Read Only
description Edm.String

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

Duration of the calendar rule in minutes.

Display Name: Duration

effectiveintervalend Edm.DateTimeOffset

Effective interval end of the calendar rule.

Display Name: Effective Interval End

effectiveintervalstart Edm.DateTimeOffset

Effective interval start of the calendar rule.

Display Name: Effective Interval Start

effort Edm.Double

Effort available for a resource during the time described by the calendar rule.

Display Name: Effort

endtime Edm.DateTimeOffset

For internal use only.

Display Name: End

extentcode Edm.Int32

Extent of the calendar rule.

Display Name: Extent Code

groupdesignator Edm.String

Unique identifier of the group.

Display Name: Group Designator

ismodified Edm.Boolean

For internal use only.

Display Name: Is Modified

Default Options
Value Label
1 Yes
0 No
isselected Edm.Boolean

Flag used in vary-by-day calendar rules.

Display Name: Is Selected

Default Options
Value Label
1 Yes
0 No
issimple Edm.Boolean

Flag used in vary-by-day calendar rules.

Display Name: Is Simple

Default Options
Value Label
1 Yes
0 No
isvaried Edm.Boolean

Flag used in leaf nonrecurring rules.

Display Name: Is Varied

Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Date and time when the calendar rule was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the calendar rule.

Display Name: Name

offset Edm.Int32

Start offset for leaf nonrecurring rules.

Display Name: Offset

organizationid Edm.Guid

Unique identifier of the organization with which the calendar rule is associated.

Display Name: Organization

Read Only
pattern Edm.String

Pattern of the rule recurrence.

Display Name: Recurrence Pattern

rank Edm.Int32

Rank of the calendar rule.

Display Name: Rank

starttime Edm.DateTimeOffset

Start time for the rule.

Display Name: Start

subcode Edm.Int32

Sub-type of calendar rule.

Display Name: Sub Code

timecode Edm.Int32

Type of calendar rule such as working hours, break, holiday, or time off.

Display Name: Type

timezonecode Edm.Int32

Local time zone for the calendar rule.

Display Name: Time Zone

versionnumber Edm.Int64
Read Only

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_calendar_rules
createdby systemuser lk_calendarrule_createdby
createdonbehalfby systemuser lk_calendarrule_createdonbehalfby
innercalendarid calendar inner_calendar_calendar_rules
modifiedby systemuser lk_calendarrule_modifiedby
modifiedonbehalfby systemuser lk_calendarrule_modifiedonbehalfby
serviceid service service_calendar_rules

Solutions

The following solutions include the calendarrule entity type.

Name Description
Service Dynamics 365 workload for service.
System Solution Internal CRM System Solution

See also