Calendar entity reference
Calendar used by the scheduling system to define when an appointment or activity is to occur.
Messages
| Message | SDK class or method |
|---|---|
| Create | CreateRequest or Create |
| Delete | DeleteRequest or Delete |
| ExpandCalendar | ExpandCalendarRequest |
| Retrieve | RetrieveRequest or Retrieve |
| RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
| Update | UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | Calendars |
| DisplayCollectionName | Calendars |
| DisplayName | Calendar |
| EntitySetName | calendars |
| IsBPFEntity | False |
| LogicalCollectionName | calendars |
| LogicalName | calendar |
| OwnershipType | BusinessOwned |
| PrimaryIdAttribute | calendarid |
| PrimaryNameAttribute | name |
| SchemaName | Calendar |
Writable attributes
These 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 |
| Targets | businessunit |
| Type | Lookup |
CalendarId
| Property | Value |
|---|---|
| Description | Unique identifier of the calendar. |
| DisplayName | Calendar |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| 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 |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | Memo |
HolidayScheduleCalendarId
| Property | Value |
|---|---|
| Description | Holiday Schedule CalendarId |
| DisplayName | Holiday Schedule CalendarId |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | holidayschedulecalendarid |
| RequiredLevel | None |
| Targets | calendar |
| Type | Lookup |
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 |
IsShared Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
Name
| Property | Value |
|---|---|
| Description | Name of the calendar. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 160 |
| RequiredLevel | None |
| Type | String |
PrimaryUserId
| Property | Value |
|---|---|
| Description | Unique identifier of the primary user of this calendar. |
| DisplayName | Primary User |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| 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 |
Type Choices/Options
| Value | Label | Description |
|---|---|---|
| -1 | Inner Calendar type | |
| 0 | Default | |
| 1 | Customer Service | |
| 2 | Holiday Schedule |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- BusinessUnitIdName
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- HolidayScheduleCalendarIdName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- VersionNumber
BusinessUnitIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | businessunitidname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the calendar. |
| DisplayName | Created By |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the calendar was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
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 |
| Targets | systemuser |
| Type | Lookup |
CreatedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
HolidayScheduleCalendarIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | holidayschedulecalendaridname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
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 |
| Targets | systemuser |
| Type | Lookup |
ModifiedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the calendar was last modified. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
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 |
| Targets | systemuser |
| Type | Lookup |
ModifiedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
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 |
| Targets | organization |
| Type | Lookup |
OrganizationIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationidname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
VersionNumber
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- calendar_bookableresources
- calendar_equipment
- calendar_services
- calendar_system_users
- Calendar_AsyncOperations
- Calendar_Annotation
- calendar_customercalendar_holidaycalendar
- Calendar_BulkDeleteFailures
- BusinessUnit_Calendar
- slabase_businesshoursid
- calendar_organization
calendar_bookableresources
Added by: Scheduling Solution
Same as the calendar_bookableresources many-to-one relationship for the bookableresource entity.
| Property | Value |
|---|---|
| ReferencingEntity | bookableresource |
| ReferencingAttribute | calendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | calendar_bookableresources |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
calendar_equipment
Added by: Service Solution
Same as the calendar_equipment many-to-one relationship for the equipment entity.
| Property | Value |
|---|---|
| ReferencingEntity | equipment |
| ReferencingAttribute | calendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | calendar_equipment |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
calendar_services
Added by: Service Solution
Same as the calendar_services many-to-one relationship for the service entity.
| Property | Value |
|---|---|
| ReferencingEntity | service |
| ReferencingAttribute | calendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | calendar_services |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
calendar_system_users
Same as the calendar_system_users many-to-one relationship for the systemuser entity.
| Property | Value |
|---|---|
| ReferencingEntity | systemuser |
| ReferencingAttribute | calendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | calendar_system_users |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Calendar_AsyncOperations
Same as the Calendar_AsyncOperations many-to-one relationship for the asyncoperation entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Calendar_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Calendar_Annotation
Same as the Calendar_Annotation many-to-one relationship for the annotation entity.
| Property | Value |
|---|---|
| ReferencingEntity | annotation |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Calendar_Annotation |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
calendar_customercalendar_holidaycalendar
Same as the calendar_customercalendar_holidaycalendar many-to-one relationship for the calendar entity.
| Property | Value |
|---|---|
| ReferencingEntity | calendar |
| ReferencingAttribute | holidayschedulecalendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | calendar_customercalendar_holidaycalendar |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Calendar_BulkDeleteFailures
Same as the Calendar_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Calendar_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
BusinessUnit_Calendar
Same as the BusinessUnit_Calendar many-to-one relationship for the businessunit entity.
| Property | Value |
|---|---|
| ReferencingEntity | businessunit |
| ReferencingAttribute | calendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | BusinessUnit_Calendar |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
slabase_businesshoursid
Same as the slabase_businesshoursid many-to-one relationship for the sla entity.
| Property | Value |
|---|---|
| ReferencingEntity | sla |
| ReferencingAttribute | businesshoursid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | slabase_businesshoursid |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
calendar_organization
Same as the calendar_organization many-to-one relationship for the organization entity.
| Property | Value |
|---|---|
| ReferencingEntity | organization |
| ReferencingAttribute | businessclosurecalendarid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | calendar_organization |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_calendar_createdby
- lk_calendar_createdonbehalfby
- lk_calendar_modifiedby
- organization_calendars
- calendar_customercalendar_holidaycalendar
- lk_calendar_modifiedonbehalfby
- business_unit_calendars
lk_calendar_createdby
See the lk_calendar_createdby one-to-many relationship for the systemuser entity.
lk_calendar_createdonbehalfby
See the lk_calendar_createdonbehalfby one-to-many relationship for the systemuser entity.
lk_calendar_modifiedby
See the lk_calendar_modifiedby one-to-many relationship for the systemuser entity.
organization_calendars
See the organization_calendars one-to-many relationship for the organization entity.
calendar_customercalendar_holidaycalendar
See the calendar_customercalendar_holidaycalendar one-to-many relationship for the calendar entity.
lk_calendar_modifiedonbehalfby
See the lk_calendar_modifiedonbehalfby one-to-many relationship for the systemuser entity.
business_unit_calendars
See the business_unit_calendars one-to-many relationship for the businessunit entity.