calendar EntityType

  • Article

 

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

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

Entity Set path:[organization URI]/api/data/v8.2/calendars

Base Type: crmbaseentity EntityType

Display Name: Calendar

Primary Key: calendarid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to calendar

Operations using the calendar entity type.

Properties

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

Name

Type

Details

calendarid

Edm.Guid

Description: Unique identifier of the calendar.

Display Name: Calendar

createdon

Edm.DateTimeOffset

Description: Date and time when the calendar was created.

Display Name: Created On

Read-only property

description

Edm.String

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

Display Name: Description

isshared

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Is Shared

modifiedon

Edm.DateTimeOffset

Description: Date and time when the calendar was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the calendar.

Display Name: Name

primaryuserid

Edm.Guid

Description: Unique identifier of the primary user of this calendar.

Display Name: Primary User

type

Edm.Int32

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

Default Options:

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

Display Name: Calendar type

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

_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 EntityType

business_unit_calendars

createdby

systemuser EntityType

lk_calendar_createdby

createdonbehalfby

systemuser EntityType

lk_calendar_createdonbehalfby

holidayschedulecalendarid

calendar EntityType

calendar_customercalendar_holidaycalendar

modifiedby

systemuser EntityType

lk_calendar_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_calendar_modifiedonbehalfby

organizationid

organization EntityType

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 EntityType

calendarid

Calendar_Annotation

annotation EntityType

objectid_calendar

Calendar_AsyncOperations

asyncoperation EntityType

regardingobjectid_calendar

calendar_bookableresources

bookableresource EntityType

calendarid

Calendar_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_calendar

calendar_calendar_rules

calendarrule EntityType

calendarid

calendar_customercalendar_holidaycalendar

calendar EntityType

holidayschedulecalendarid

calendar_equipment

equipment EntityType

calendarid

calendar_organization

organization EntityType

businessclosurecalendarid_calendar

calendar_services

service EntityType

calendarid_calendar

calendar_system_users

systemuser EntityType

calendarid

inner_calendar_calendar_rules

calendarrule EntityType

innercalendarid

slabase_businesshoursid

sla EntityType

businesshoursid

Operations bound to calendar

The following operations are bound to the calendar entity type.

Name

Bound to

ExpandCalendar Function

Entity

Operations using the calendar entity type.

The following operations use the calendar entity type in a parameter or return type.

Name

How used

Description

ExpandCalendar Function

entity Parameter

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

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