Edit

Share via

Calendar table/entity reference (Microsoft Dataverse)

Calendar used by the scheduling system to define when an appointment or activity is to occur.

Messages

The following table lists the messages for the Calendar table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /calendars
See Create		 Create records
Delete
Event: True		 DELETE /calendars(calendarid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
ExpandCalendar
Event: False		 ExpandCalendar ExpandCalendarRequest
Retrieve
Event: True		 GET /calendars(calendarid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /calendars
See Query data		 Query data
Update
Event: True		 PATCH /calendars(calendarid)
See Update		 Update records
Upsert
Event: False		 PATCH /calendars(calendarid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Calendar table.

Property Value
DisplayName Calendar
DisplayCollectionName Calendars
SchemaName Calendar
CollectionSchemaName Calendars
EntitySetName calendars
LogicalName calendar
LogicalCollectionName calendars
PrimaryIdAttribute calendarid
PrimaryNameAttribute name
TableType Standard
OwnershipType BusinessOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

BusinessUnitId

Property Value
Description Unique identifier of the business unit with which the calendar is associated.
DisplayName Business Unit
IsValidForForm False
IsValidForRead True
LogicalName businessunitid
RequiredLevel None
Type Lookup
Targets businessunit

CalendarId

Property Value
Description Unique identifier of the calendar.
DisplayName Calendar
IsValidForForm False
IsValidForRead True
LogicalName calendarid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Property Value
Description Calendar used by the scheduling system to define when an appointment or activity is to occur.
DisplayName Description
IsValidForForm False
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

HolidayScheduleCalendarId

Property Value
Description Holiday Schedule CalendarId
DisplayName Holiday Schedule CalendarId
IsValidForForm True
IsValidForRead True
LogicalName holidayschedulecalendarid
RequiredLevel None
Type Lookup
Targets calendar

IsShared

Property Value
Description Calendar is shared by other calendars, such as the organization calendar.
DisplayName Is Shared
IsValidForForm False
IsValidForRead True
LogicalName isshared
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName calendar_isshared
DefaultValue False
True Label Yes
False Label No

Name

Property Value
Description Name of the calendar.
DisplayName Name
IsValidForForm False
IsValidForRead True
LogicalName name
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 160

PrimaryUserId

Property Value
Description Unique identifier of the primary user of this calendar.
DisplayName Primary User
IsValidForForm False
IsValidForRead True
LogicalName primaryuserid
RequiredLevel ApplicationRequired
Type Uniqueidentifier

Type

Property Value
Description Calendar type, such as User work hour calendar, or Customer service hour calendar.
DisplayName Calendar type
IsValidForForm True
IsValidForRead True
LogicalName type
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 0
GlobalChoiceName calendar_type

Type Choices/Options

Value Label
-1 Inner Calendar type
0 Default
1 Customer Service
2 Holiday Schedule

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Unique identifier of the user who created the calendar.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the calendar was created.
DisplayName Created On
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the calendar.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the calendar.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the calendar was last modified.
DisplayName Modified On
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the calendar.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OrganizationId

Property Value
Description Unique identifier of the organization with which the calendar is associated.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Type Lookup
Targets organization

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_calendars

One-To-Many Relationship: businessunit business_unit_calendars

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute businessunitid
ReferencingEntityNavigationPropertyName businessunitid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

calendar_customercalendar_holidaycalendar

One-To-Many Relationship: calendar calendar_customercalendar_holidaycalendar

Property Value
ReferencedEntity calendar
ReferencedAttribute calendarid
ReferencingAttribute holidayschedulecalendarid
ReferencingEntityNavigationPropertyName holidayschedulecalendarid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_calendar_createdby

One-To-Many Relationship: systemuser lk_calendar_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_calendar_createdonbehalfby

One-To-Many Relationship: systemuser lk_calendar_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_calendar_modifiedby

One-To-Many Relationship: systemuser lk_calendar_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_calendar_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_calendar_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_calendars

One-To-Many Relationship: organization organization_calendars

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

BusinessUnit_Calendar

Many-To-One Relationship: businessunit BusinessUnit_Calendar

Property Value
ReferencingEntity businessunit
ReferencingAttribute calendarid
ReferencedEntityNavigationPropertyName BusinessUnit_Calendar
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Calendar_Annotation

Many-To-One Relationship: annotation Calendar_Annotation

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName Calendar_Annotation
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Calendar_AsyncOperations

Many-To-One Relationship: asyncoperation Calendar_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Calendar_AsyncOperations
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

Calendar_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure Calendar_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName Calendar_BulkDeleteFailures
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

calendar_calendar_rules

Many-To-One Relationship: calendarrule calendar_calendar_rules

Property Value
ReferencingEntity calendarrule
ReferencingAttribute calendarid
ReferencedEntityNavigationPropertyName calendar_calendar_rules
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

calendar_customercalendar_holidaycalendar

Many-To-One Relationship: calendar calendar_customercalendar_holidaycalendar

Property Value
ReferencingEntity calendar
ReferencingAttribute holidayschedulecalendarid
ReferencedEntityNavigationPropertyName calendar_customercalendar_holidaycalendar
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

calendar_organization

Many-To-One Relationship: organization calendar_organization

Property Value
ReferencingEntity organization
ReferencingAttribute businessclosurecalendarid
ReferencedEntityNavigationPropertyName calendar_organization
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

calendar_slaitem

Many-To-One Relationship: slaitem calendar_slaitem

Property Value
ReferencingEntity slaitem
ReferencingAttribute businesshoursid
ReferencedEntityNavigationPropertyName calendar_slaitem
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

calendar_system_users

Many-To-One Relationship: systemuser calendar_system_users

Property Value
ReferencingEntity systemuser
ReferencingAttribute calendarid
ReferencedEntityNavigationPropertyName calendar_system_users
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

inner_calendar_calendar_rules

Many-To-One Relationship: calendarrule inner_calendar_calendar_rules

Property Value
ReferencingEntity calendarrule
ReferencingAttribute innercalendarid
ReferencedEntityNavigationPropertyName inner_calendar_calendar_rules
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

slabase_businesshoursid

Many-To-One Relationship: sla slabase_businesshoursid

Property Value
ReferencingEntity sla
ReferencingAttribute businesshoursid
ReferencedEntityNavigationPropertyName slabase_businesshoursid
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
calendar