Edit

Share via

Recurrence Rule (RecurrenceRule) table/entity reference

  • Article

Recurrence Rule represents the pattern of incidence of recurring entities.

Messages

The following table lists the messages for the Recurrence Rule (RecurrenceRule) 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
Create
Event: True		 POST /recurrencerules
See Create		 Create records
Delete
Event: True		 DELETE /recurrencerules(ruleid)
See Delete		 Delete records
Retrieve
Event: False		 GET /recurrencerules(ruleid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /recurrencerules
See Query data		 Query data
Update
Event: True		 PATCH /recurrencerules(ruleid)
See Update		 Update records
ValidateRecurrenceRule
Event: True		 ValidateRecurrenceRule ValidateRecurrenceRuleRequest
Upsert
Event: False		 PATCH /recurrencerules(ruleid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Recurrence Rule (RecurrenceRule) table.

Property Value
DisplayName Recurrence Rule
DisplayCollectionName Recurrence Rules
SchemaName RecurrenceRule
CollectionSchemaName RecurrenceRules
EntitySetName recurrencerules
LogicalName recurrencerule
LogicalCollectionName recurrencerules
PrimaryIdAttribute ruleid
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

These columns/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
IsValidForForm False
IsValidForRead True
LogicalName dayofmonth
RequiredLevel None
Type Integer
MaxValue 31
MinValue 0

DaysOfWeekMask

Property Value
Description Bitmask representing the days of the week on which the recurring appointment or task occurs.
DisplayName Days Of Week Mask
IsValidForForm False
IsValidForRead True
LogicalName daysofweekmask
RequiredLevel None
Type Integer
MaxValue 127
MinValue 1

Duration

Property Value
Description Duration of the recurrence pattern in minutes.
DisplayName Duration
IsValidForForm False
IsValidForRead True
LogicalName duration
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

EffectiveEndDate

Property Value
Description The actual end date for expansion of the recurrence pattern.
DisplayName Effective End Date
IsValidForForm False
IsValidForRead True
LogicalName effectiveenddate
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

EffectiveStartDate

Property Value
Description The actual start date for expansion of the recurrence pattern.
DisplayName Effective Start Date
IsValidForForm False
IsValidForRead True
LogicalName effectivestartdate
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

EndTime

Property Value
Description End time of the associated activity.
DisplayName End Time
IsValidForForm False
IsValidForRead True
LogicalName endtime
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

FirstDayOfWeek

Property Value
Description First day Of week for the recurrence pattern.
DisplayName First Day Of Week
IsValidForForm False
IsValidForRead True
LogicalName firstdayofweek
RequiredLevel None
Type Integer
MaxValue 6
MinValue 0

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
DefaultFormValue
GlobalChoiceName recurrencerule_instance

Instance Choices/Options

Value Label
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
IsValidForForm False
IsValidForRead True
LogicalName interval
RequiredLevel None
Type Integer
MaxValue 1000
MinValue 1

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
GlobalChoiceName recurrencerule_isnthmonthly
DefaultValue False
True Label Yes
False Label No

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
GlobalChoiceName recurrencerule_isnthyearly
DefaultValue False
True Label Yes
False Label No

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
GlobalChoiceName recurrencerule_isregenerate
DefaultValue False
True Label Yes
False Label No

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
GlobalChoiceName recurrencerule_isweekdaypattern
DefaultValue False
True Label Yes
False Label No

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
DefaultFormValue 0
GlobalChoiceName recurrencerule_monthofyear

MonthOfYear Choices/Options

Value Label
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
Type Lookup
Targets activitypointer

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
IsValidForForm False
IsValidForRead True
LogicalName occurrences
RequiredLevel None
Type Integer
MaxValue 999
MinValue 1

OwnerId

Property Value
Description Unique identifier of the user or team who owns the recurrence rule.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

PatternEndDate

Property Value
Description End date of the Recurrence Range.
DisplayName Recurrence Range End
IsValidForForm True
IsValidForRead True
LogicalName patternenddate
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

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
DefaultFormValue 0
GlobalChoiceName recurrencerule_patternendtype

PatternEndType Choices/Options

Value Label
1 No End Date
2 Occurrences
3 Pattern End Date

PatternStartDate

Property Value
Description Start date of the Recurrence Range.
DisplayName Recurrence Range Start
IsValidForForm True
IsValidForRead True
LogicalName patternstartdate
RequiredLevel ApplicationRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

RecurrencePatternType

Property Value
Description Type of Recurrence.
DisplayName Recurrence Pattern
IsValidForForm True
IsValidForRead True
LogicalName recurrencepatterntype
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 0
GlobalChoiceName recurrencerule_recurrencepatterntype

RecurrencePatternType Choices/Options

Value Label
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
LogicalName ruleid
RequiredLevel SystemRequired
Type Uniqueidentifier

StartTime

Property Value
Description Start time of the recurring activity.
DisplayName Start Time
IsValidForForm False
IsValidForRead True
LogicalName starttime
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

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 recurrence rule.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the recurrence rule was created.
DisplayName Created On
IsValidForForm True
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 recurrence rule.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

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
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the recurrence rule was last modified.
DisplayName Modified On
IsValidForForm True
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 modified the recurrence rule.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OwnerIdName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwnerIdYomiName

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the recurrence rule.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

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.

activity_pointer_recurrencerule

One-To-Many Relationship: activitypointer activity_pointer_recurrencerule

Property Value
ReferencedEntity activitypointer
ReferencedAttribute activityid
ReferencingAttribute objectid
ReferencingEntityNavigationPropertyName objectid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: Cascade
Unshare: Cascade

business_unit_recurrencerule

One-To-Many Relationship: businessunit business_unit_recurrencerule

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

lk_recurrencerule_createdby

One-To-Many Relationship: systemuser lk_recurrencerule_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_recurrencerule_modifiedby

One-To-Many Relationship: systemuser lk_recurrencerule_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_recurrencerulebase_createdonbehalfby

One-To-Many Relationship: systemuser lk_recurrencerulebase_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_recurrencerulebase_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_recurrencerulebase_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

owner_recurrencerules

One-To-Many Relationship: owner owner_recurrencerules

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
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.

recurrencerule_recurringappointmentmaster

Many-To-One Relationship: recurringappointmentmaster recurrencerule_recurringappointmentmaster

Property Value
ReferencingEntity recurringappointmentmaster
ReferencingAttribute activityid
ReferencedEntityNavigationPropertyName recurrencerule_recurringappointmentmaster
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
recurrencerule