recurrencerule EntityType

Recurrence Rule represents the pattern of incidence of recurring entities.

Entity Set Path
[organization URI]/api/data/v9.0/recurrencerules
Base Type
crmbaseentity
Display Name
Recurrence Rule
Primary Key
ruleid
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
createdon Edm.DateTimeOffset

Date and time when the recurrence rule was created.

Display Name: Created On

Read Only
dayofmonth Edm.Int32

The day of the month on which the recurring appointment or task occurs.

Display Name: Day Of Month

daysofweekmask Edm.Int32

Bitmask representing the days of the week on which the recurring appointment or task occurs.

Display Name: Days Of Week Mask

duration Edm.Int32

Duration of the recurrence pattern in minutes.

Display Name: Duration

effectiveenddate Edm.DateTimeOffset

The actual end date for expansion of the recurrence pattern.

Display Name: Effective End Date

effectivestartdate Edm.DateTimeOffset

The actual start date for expansion of the recurrence pattern.

Display Name: Effective Start Date

endtime Edm.DateTimeOffset

End time of the associated activity.

Display Name: End Time

firstdayofweek Edm.Int32

First day Of week for the recurrence pattern.

Display Name: First Day Of Week

instance Edm.Int32

Specifies the count for which the recurrence pattern is valid for a given interval.

Display Name: Instance

Default Options
Value Label
1 First
2 Second
3 Third
4 Fourth
5 Last
interval Edm.Int32

Number of units of a given recurrence type between occurrences.

Display Name: Interval

isnthmonthly Edm.Boolean

Specifies whether the monthly recurrence pattern is Nth monthly, valid only for monthly recurrence.

Display Name: Nth Monthly

Default Options
Value Label
1 Yes
0 No
isnthyearly Edm.Boolean

Specifies whether the yearly recurrence pattern is Nth yearly, valid only for yearly recurrence.

Display Name: Nth Yearly

Default Options
Value Label
1 Yes
0 No
isregenerate Edm.Boolean

Valid only for task type recurrence,indicates whether task should be regenerated.

Display Name: Regenerate

Default Options
Value Label
1 Yes
0 No
isweekdaypattern Edm.Boolean

Specifies whether the weekly recurrence pattern is actually a daily every weekday pattern, valid only for weekly recurrence.

Display Name: Every Weekday

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

Date and time when the recurrence rule was last modified.

Display Name: Modified On

Read Only
monthofyear Edm.Int32

Specifies the month of the year valid for the recurrence pattern.

Display Name: Month Of Year

Default 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
occurrences Edm.Int32

Number of occurrences of the recurrence pattern.

Display Name: Occurrences

patternenddate Edm.DateTimeOffset

End date of the Recurrence Range.

Display Name: Recurrence Range End

patternendtype Edm.Int32

Pattern End Type of a recurring series.

Display Name: Pattern End Type

Default Options
Value Label
1 No End Date
2 Occurrences
3 Pattern End Date
patternstartdate Edm.DateTimeOffset

Start date of the Recurrence Range.

Display Name: Recurrence Range Start

recurrencepatterntype Edm.Int32

Type of Recurrence.

Display Name: Recurrence Pattern

Default Options
Value Label
0 Daily
1 Weekly
2 Monthly
3 Yearly
ruleid Edm.Guid

Unique identifier of the entity associated with recurrence rule.

Display Name: Recurrence Rule

starttime Edm.DateTimeOffset

Start time of the recurring activity.

Display Name: Start Time

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
_createdby_value createdby

Unique identifier of the user who created the recurrence rule.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the recurrence rule.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the recurrence rule.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the recurrence rule.

_objectid_value objectid

Unique identifier of the object with which the recurrence rule is associated.

_ownerid_value ownerid

Unique identifier of the user or team who owns the recurrence rule.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the recurrence rule.

_owningteam_value createdby
_owninguser_value createdby

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
createdby systemuser lk_recurrencerule_createdby
createdonbehalfby systemuser lk_recurrencerulebase_createdonbehalfby
modifiedby systemuser lk_recurrencerule_modifiedby
modifiedonbehalfby systemuser lk_recurrencerulebase_modifiedonbehalfby
objectid activitypointer activity_pointer_recurrencerule
ownerid principal owner_recurrencerules
owningbusinessunit businessunit business_unit_recurrencerule

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
recurrencerule_recurringappointmentmaster recurringappointmentmaster activityid_recurrencerule

Operations

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

Name Binding
ValidateRecurrenceRule Not Bound

Solutions

The following solutions include the recurrencerule entity type.

Name Description
System Solution Internal CRM System Solution

See also