RecurrenceRule entity reference
Recurrence Rule represents the pattern of incidence of recurring entities.
Messages
Properties
| Property |
Value |
| CollectionSchemaName |
RecurrenceRules |
| DisplayCollectionName |
Recurrence Rules |
| DisplayName |
Recurrence Rule |
| EntitySetName |
recurrencerules |
| IsBPFEntity |
False |
| LogicalCollectionName |
recurrencerules |
| LogicalName |
recurrencerule |
| OwnershipType |
UserOwned |
| PrimaryIdAttribute |
ruleid |
| PrimaryNameAttribute |
|
| SchemaName |
RecurrenceRule |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
DayOfMonth
| Property |
Value |
| Description |
The day of the month on which the recurring appointment or task occurs. |
| DisplayName |
Day Of Month |
| Format |
None |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
dayofmonth |
| MaxValue |
31 |
| MinValue |
0 |
| RequiredLevel |
None |
| Type |
Integer |
DaysOfWeekMask
| Property |
Value |
| Description |
Bitmask representing the days of the week on which the recurring appointment or task occurs. |
| DisplayName |
Days Of Week Mask |
| Format |
None |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
daysofweekmask |
| MaxValue |
127 |
| MinValue |
1 |
| RequiredLevel |
None |
| Type |
Integer |
Duration
| Property |
Value |
| Description |
Duration of the recurrence pattern in minutes. |
| DisplayName |
Duration |
| Format |
Duration |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
duration |
| MaxValue |
2147483647 |
| MinValue |
0 |
| RequiredLevel |
None |
| Type |
Integer |
EffectiveEndDate
| Property |
Value |
| DateTimeBehavior |
UserLocal |
| Description |
The actual end date for expansion of the recurrence pattern. |
| DisplayName |
Effective End Date |
| Format |
DateAndTime |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
effectiveenddate |
| RequiredLevel |
None |
| Type |
DateTime |
EffectiveStartDate
| Property |
Value |
| DateTimeBehavior |
UserLocal |
| Description |
The actual start date for expansion of the recurrence pattern. |
| DisplayName |
Effective Start Date |
| Format |
DateOnly |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
effectivestartdate |
| RequiredLevel |
None |
| Type |
DateTime |
EndTime
| Property |
Value |
| DateTimeBehavior |
UserLocal |
| Description |
End time of the associated activity. |
| DisplayName |
End Time |
| Format |
DateAndTime |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
endtime |
| RequiredLevel |
None |
| Type |
DateTime |
FirstDayOfWeek
| Property |
Value |
| Description |
First day Of week for the recurrence pattern. |
| DisplayName |
First Day Of Week |
| Format |
None |
| IsValidForForm |
False |
| IsValidForRead |
True |
| IsValidForUpdate |
False |
| LogicalName |
firstdayofweek |
| MaxValue |
6 |
| MinValue |
0 |
| RequiredLevel |
None |
| Type |
Integer |
Instance
| Property |
Value |
| Description |
Specifies the count for which the recurrence pattern is valid for a given interval. |
| DisplayName |
Instance |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
instance |
| RequiredLevel |
None |
| Type |
Picklist |
Instance Choices/Options
| Value |
Label |
Description |
| 1 |
First |
|
| 2 |
Second |
|
| 3 |
Third |
|
| 4 |
Fourth |
|
| 5 |
Last |
|
Interval
| Property |
Value |
| Description |
Number of units of a given recurrence type between occurrences. |
| DisplayName |
Interval |
| Format |
None |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
interval |
| MaxValue |
1000 |
| MinValue |
1 |
| RequiredLevel |
None |
| Type |
Integer |
IsNthMonthly
| Property |
Value |
| Description |
Specifies whether the monthly recurrence pattern is Nth monthly, valid only for monthly recurrence. |
| DisplayName |
Nth Monthly |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
isnthmonthly |
| RequiredLevel |
SystemRequired |
| Type |
Boolean |
IsNthMonthly Choices/Options
| Value |
Label |
Description |
| 1 |
Yes |
|
| 0 |
No |
|
DefaultValue: 0
IsNthYearly
| Property |
Value |
| Description |
Specifies whether the yearly recurrence pattern is Nth yearly, valid only for yearly recurrence. |
| DisplayName |
Nth Yearly |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
isnthyearly |
| RequiredLevel |
SystemRequired |
| Type |
Boolean |
IsNthYearly Choices/Options
| Value |
Label |
Description |
| 1 |
Yes |
|
| 0 |
No |
|
DefaultValue: 0
IsRegenerate
| Property |
Value |
| Description |
Valid only for task type recurrence,indicates whether task should be regenerated. |
| DisplayName |
Regenerate |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
isregenerate |
| RequiredLevel |
SystemRequired |
| Type |
Boolean |
IsRegenerate Choices/Options
| Value |
Label |
Description |
| 1 |
Yes |
|
| 0 |
No |
|
DefaultValue: 0
IsWeekDayPattern
| Property |
Value |
| Description |
Specifies whether the weekly recurrence pattern is actually a daily every weekday pattern, valid only for weekly recurrence. |
| DisplayName |
Every Weekday |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
isweekdaypattern |
| RequiredLevel |
SystemRequired |
| Type |
Boolean |
IsWeekDayPattern Choices/Options
| Value |
Label |
Description |
| 1 |
Yes |
|
| 0 |
No |
|
DefaultValue: 0
MonthOfYear
| Property |
Value |
| Description |
Specifies the month of the year valid for the recurrence pattern. |
| DisplayName |
Month Of Year |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
monthofyear |
| RequiredLevel |
None |
| Type |
Picklist |
MonthOfYear Choices/Options
| Value |
Label |
Description |
| 0 |
Invalid Month Of Year |
|
| 1 |
January |
|
| 2 |
February |
|
| 3 |
March |
|
| 4 |
April |
|
| 5 |
May |
|
| 6 |
June |
|
| 7 |
July |
|
| 8 |
August |
|
| 9 |
September |
|
| 10 |
October |
|
| 11 |
November |
|
| 12 |
December |
|
ObjectId
| Property |
Value |
| Description |
Unique identifier of the object with which the recurrence rule is associated. |
| DisplayName |
Regarding |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
objectid |
| RequiredLevel |
None |
| Targets |
activitypointer |
| Type |
Lookup |
ObjectTypeCode
| Property |
Value |
| Description |
|
| DisplayName |
Object Type |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
objecttypecode |
| RequiredLevel |
None |
| Type |
EntityName |
Occurrences
| Property |
Value |
| Description |
Number of occurrences of the recurrence pattern. |
| DisplayName |
Occurrences |
| Format |
None |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
occurrences |
| MaxValue |
999 |
| MinValue |
1 |
| RequiredLevel |
None |
| Type |
Integer |
OwnerId
| Property |
Value |
| Description |
Unique identifier of the user or team who owns the recurrence rule. |
| DisplayName |
Owner |
| IsValidForForm |
False |
| IsValidForRead |
True |
| IsValidForUpdate |
False |
| LogicalName |
ownerid |
| RequiredLevel |
SystemRequired |
| Targets |
systemuser,team |
| Type |
Owner |
OwnerIdType
| Property |
Value |
| Description |
|
| DisplayName |
|
| IsValidForForm |
False |
| IsValidForRead |
True |
| IsValidForUpdate |
False |
| LogicalName |
owneridtype |
| RequiredLevel |
SystemRequired |
| Type |
EntityName |
PatternEndDate
| Property |
Value |
| DateTimeBehavior |
UserLocal |
| Description |
End date of the Recurrence Range. |
| DisplayName |
Recurrence Range End |
| Format |
DateAndTime |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
patternenddate |
| RequiredLevel |
None |
| Type |
DateTime |
PatternEndType
| Property |
Value |
| Description |
Pattern End Type of a recurring series. |
| DisplayName |
Pattern End Type |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
patternendtype |
| RequiredLevel |
SystemRequired |
| Type |
Picklist |
PatternEndType Choices/Options
| Value |
Label |
Description |
| 1 |
No End Date |
|
| 2 |
Occurrences |
|
| 3 |
Pattern End Date |
|
PatternStartDate
| Property |
Value |
| DateTimeBehavior |
UserLocal |
| Description |
Start date of the Recurrence Range. |
| DisplayName |
Recurrence Range Start |
| Format |
DateAndTime |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
patternstartdate |
| RequiredLevel |
ApplicationRequired |
| Type |
DateTime |
RecurrencePatternType
| Property |
Value |
| Description |
Type of Recurrence. |
| DisplayName |
Recurrence Pattern |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
recurrencepatterntype |
| RequiredLevel |
SystemRequired |
| Type |
Picklist |
RecurrencePatternType Choices/Options
| Value |
Label |
Description |
| 0 |
Daily |
|
| 1 |
Weekly |
|
| 2 |
Monthly |
|
| 3 |
Yearly |
|
RuleId
| Property |
Value |
| Description |
Unique identifier of the entity associated with recurrence rule. |
| DisplayName |
Recurrence Rule |
| IsValidForForm |
False |
| IsValidForRead |
True |
| IsValidForUpdate |
False |
| LogicalName |
ruleid |
| RequiredLevel |
SystemRequired |
| Type |
Uniqueidentifier |
StartTime
| Property |
Value |
| DateTimeBehavior |
UserLocal |
| Description |
Start time of the recurring activity. |
| DisplayName |
Start Time |
| Format |
DateAndTime |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
starttime |
| RequiredLevel |
None |
| Type |
DateTime |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
CreatedBy
| Property |
Value |
| Description |
Unique identifier of the user who created the recurrence rule. |
| DisplayName |
Created By |
| IsValidForForm |
True |
| 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 recurrence rule was created. |
| DisplayName |
Created On |
| Format |
DateAndTime |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
createdon |
| RequiredLevel |
None |
| Type |
DateTime |
CreatedOnBehalfBy
| Property |
Value |
| Description |
Unique identifier of the delegate user who created the recurrence rule. |
| DisplayName |
Created By (Delegate) |
| IsValidForForm |
True |
| 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 |
ModifiedBy
| Property |
Value |
| Description |
Unique identifier of the user who last modified the recurrence rule. |
| DisplayName |
Modified By |
| IsValidForForm |
True |
| 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 recurrence rule was last modified. |
| DisplayName |
Modified On |
| Format |
DateAndTime |
| IsValidForForm |
True |
| IsValidForRead |
True |
| LogicalName |
modifiedon |
| RequiredLevel |
None |
| Type |
DateTime |
ModifiedOnBehalfBy
| Property |
Value |
| Description |
Unique identifier of the delegate user who modified the recurrence rule. |
| DisplayName |
Created By (Delegate) |
| IsValidForForm |
True |
| 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 |
OwnerIdName
| Property |
Value |
| Description |
|
| DisplayName |
|
| FormatName |
Text |
| IsLocalizable |
False |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
owneridname |
| MaxLength |
100 |
| RequiredLevel |
SystemRequired |
| Type |
String |
OwnerIdYomiName
| Property |
Value |
| Description |
|
| DisplayName |
|
| FormatName |
Text |
| IsLocalizable |
False |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
owneridyominame |
| MaxLength |
100 |
| RequiredLevel |
SystemRequired |
| Type |
String |
OwningBusinessUnit
| Property |
Value |
| Description |
Unique identifier of the business unit that owns the recurrence rule. |
| DisplayName |
Owning Business Unit |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
owningbusinessunit |
| RequiredLevel |
None |
| Targets |
businessunit |
| Type |
Lookup |
OwningTeam
| Property |
Value |
| Description |
|
| DisplayName |
Owning Team |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
owningteam |
| RequiredLevel |
None |
| Targets |
team |
| Type |
Lookup |
OwningUser
| Property |
Value |
| Description |
|
| DisplayName |
Owning User |
| IsValidForForm |
False |
| IsValidForRead |
True |
| LogicalName |
owninguser |
| RequiredLevel |
None |
| Targets |
systemuser |
| Type |
Lookup |
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.
recurrencerule_recurringappointmentmaster
Same as the recurrencerule_recurringappointmentmaster many-to-one relationship for the recurringappointmentmaster entity.
| Property |
Value |
| ReferencingEntity |
recurringappointmentmaster |
| ReferencingAttribute |
activityid |
| IsHierarchical |
False |
| IsCustomizable |
False |
| ReferencedEntityNavigationPropertyName |
recurrencerule_recurringappointmentmaster |
| AssociatedMenuConfiguration |
Behavior: DoNotDisplay
Group: Details
Label:
Order: |
| CascadeConfiguration |
Assign: NoCascade
Delete: NoCascade
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.
business_unit_recurrencerule
See the business_unit_recurrencerule one-to-many relationship for the businessunit entity.
activity_pointer_recurrencerule
See the activity_pointer_recurrencerule one-to-many relationship for the activitypointer entity.
lk_recurrencerule_modifiedby
See the lk_recurrencerule_modifiedby one-to-many relationship for the systemuser entity.
lk_recurrencerule_createdby
See the lk_recurrencerule_createdby one-to-many relationship for the systemuser entity.
lk_recurrencerulebase_createdonbehalfby
See the lk_recurrencerulebase_createdonbehalfby one-to-many relationship for the systemuser entity.
lk_recurrencerulebase_modifiedonbehalfby
See the lk_recurrencerulebase_modifiedonbehalfby one-to-many relationship for the systemuser entity.
See also
About the Entity Reference
Web API EntityType Reference