calendar EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/calendars
Base Type
crmbaseentity
Display Name
Calendar
Primary Key
calendarid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
calendarid Edm.Guid

Unique identifier of the calendar.

Display Name: Calendar

createdon Edm.DateTimeOffset

Date and time when the calendar was created.

Display Name: Created On

Read Only
description Edm.String

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

Display Name: Description

isshared Edm.Boolean

Calendar is shared by other calendars, such as the organization calendar.

Display Name: Is Shared

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

Date and time when the calendar was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the calendar.

Display Name: Name

primaryuserid Edm.Guid

Unique identifier of the primary user of this calendar.

Display Name: Primary User

type Edm.Int32

Calendar type, such as User work hour calendar, or Customer service hour calendar.

Display Name: Calendar type

Default Options
Value Label
0 Default
1 Customer Service
2 Holiday Schedule
-1 Inner Calendar type
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
_businessunitid_value businessunitid

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

_createdby_value createdby

Unique identifier of the user who created the calendar.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the calendar.

_holidayschedulecalendarid_value holidayschedulecalendarid

Holiday Schedule CalendarId

_modifiedby_value modifiedby

Unique identifier of the user who last modified the calendar.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the calendar.

_organizationid_value organizationid

Unique identifier of the organization with which the calendar 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
businessunitid businessunit business_unit_calendars
createdby systemuser lk_calendar_createdby
createdonbehalfby systemuser lk_calendar_createdonbehalfby
holidayschedulecalendarid calendar calendar_customercalendar_holidaycalendar
modifiedby systemuser lk_calendar_modifiedby
modifiedonbehalfby systemuser lk_calendar_modifiedonbehalfby
organizationid organization organization_calendars

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
BusinessUnit_Calendar businessunit calendarid
Calendar_Annotation annotation objectid_calendar
Calendar_AsyncOperations asyncoperation regardingobjectid_calendar
calendar_bookableresources bookableresource calendarid
Calendar_BulkDeleteFailures bulkdeletefailure regardingobjectid_calendar
calendar_calendar_rules calendarrule calendarid
calendar_customercalendar_holidaycalendar calendar holidayschedulecalendarid
calendar_equipment equipment calendarid
calendar_organization organization businessclosurecalendarid_calendar
calendar_services service calendarid_calendar
calendar_system_users systemuser calendarid
inner_calendar_calendar_rules calendarrule innercalendarid
slabase_businesshoursid sla businesshoursid

Operations

The following operations can be used with the calendar entity type.

Name Binding
ExpandCalendar Entity

Solutions

The following solutions include the calendar entity type.

Name Description
System Solution Internal CRM System Solution

See also