recurringappointmentmaster EntityType

The Master appointment of a recurring appointment series.

Entity Set Path
[organization URI]/api/data/v9.0/recurringappointmentmasters
Base Type
activitypointer
Display Name
Recurring Appointment
Primary Key
activityid
Primary Key Attribute
subject
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
activityadditionalparams Edm.String

Additional information provided by the external application as JSON. For internal use only.

activityid Edm.Guid

Unique identifier of the activity.

Display Name: Recurring Appointment

activitytypecode Edm.String

Type of activity.

Display Name: Activity Type

Read Only
actualdurationminutes Edm.Int32

Actual duration of the activity in minutes.

actualend Edm.DateTimeOffset

Actual end time of the activity.

actualstart Edm.DateTimeOffset

Actual start time of the activity.

category Edm.String

Type a category to identify the recurring appointment type, such as status meeting or service call, to tie the appointment to a business group or function.

Display Name: Category

community Edm.Int32

Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only.

createdon Edm.DateTimeOffset

Date and time when the activity was created.

Display Name: Created On

Read Only
dayofmonth Edm.Int32

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

Display Name: Day Of Month

daysofweekmask Edm.Int32

Bitmask that represents the days of the week on which the recurring appointment occurs.

Display Name: Days Of Week Mask

deletedexceptionslist Edm.String

List of deleted instances of the recurring appointment series.

Display Name: Deleted Appointments

Read Only
deliverylastattemptedon Edm.DateTimeOffset

Date and time when the delivery of the activity was last attempted.

Read Only
deliveryprioritycode Edm.Int32

Priority of delivery of the activity to the email server.

description Edm.String

Description of the activity.

Display Name: Description

duration Edm.Int32

Duration of the recurring appointment series in minutes.

Display Name: Duration

effectiveenddate Edm.DateTimeOffset

Actual end date of the recurring appointment series based on the specified end date and recurrence pattern.

Display Name: Effective End Date

effectivestartdate Edm.DateTimeOffset

Actual start date of the recurring appointment series based on the specified start date and recurrence pattern.

Display Name: Effective Start Date

endtime Edm.DateTimeOffset

End time of the associated activity.

Display Name: Pattern End Time

exchangeitemid Edm.String

The message id of activity which is returned from Exchange Server.

exchangerate Edm.Decimal

Exchange rate for the currency associated with the activitypointer with respect to the base currency.

Display Name: Exchange Rate

Read Only
exchangeweblink Edm.String

Shows the web link of Activity of type email.

expansionstatecode Edm.Int32

State code to indicate whether the recurring appointment series is expanded fully or partially.

Display Name: Expansion State Code

Read Only
Default Options
Value Label
0 Unexpanded
1 Partial
2 Full
firstdayofweek Edm.Int32

First day of week for the recurrence pattern.

Display Name: First Day Of Week

globalobjectid Edm.String

Unique Outlook identifier to correlate recurring appointment series across Exchange mailboxes.

Display Name: Outlook Recurring Appointment Master

importsequencenumber Edm.Int32

Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

instance Edm.Int32

Specifies the recurring appointment series to occur on every Nth day of a month. Valid for monthly and yearly recurrence patterns only.

Display Name: Instance

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

Type of instance of a recurring series.

Display Name: Appointment Type

Read Only
Default Options
Value Label
0 Not Recurring
1 Recurring Master
2 Recurring Instance
3 Recurring Exception
4 Recurring Future Exception
interval Edm.Int32

Number of units of a given recurrence type between occurrences.

Display Name: Interval

isalldayevent Edm.Boolean

Select whether the recurring appointment is an all-day event to make sure that the required resources are scheduled for the full day.

Display Name: All Day Event

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

Information regarding whether the activity was billed as part of resolving a case.

Display Name: Is Billed

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

For internal use only.

Display Name: Is Private

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

Indicates whether the recurring appointment series should occur after every N months. Valid for monthly recurrence pattern only.

Display Name: Nth Monthly

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

Indicates whether the recurring appointment series should occur after every N years. Valid for yearly recurrence pattern only.

Display Name: Nth Yearly

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

For internal use only.

Display Name: Regenerate

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

Information regarding whether the activity is a regular activity type or event type.

Display Name: Is Regular Activity

Read Only
Default Options
Value Label
1 Yes
0 No
isunsafe Edm.Int32

For internal use only.

Display Name: IsUnsafe

Read Only
isweekdaypattern Edm.Boolean

Indicates whether the weekly recurrence pattern is a daily weekday pattern. Valid for weekly recurrence pattern only.

Display Name: Every Weekday

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

Information regarding whether the activity was created from a workflow rule.

Display Name: Is Workflow Created

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

Date of last expanded instance of a recurring appointment series.

Display Name: Last Expanded Instance Date

Read Only
lastonholdtime Edm.DateTimeOffset

Contains the date and time stamp of the last on hold time.

leftvoicemail Edm.Boolean

Left the voice mail

location Edm.String

Type the location where the recurring appointment will take place, such as a conference room or customer office.

Display Name: Location

modifiedon Edm.DateTimeOffset

Date and time when activity was last modified.

Display Name: Modified On

Read Only
monthofyear Edm.Int32

Indicates the month of the year 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
nextexpansioninstancedate Edm.DateTimeOffset

Date of the next expanded instance of a recurring appointment series.

Display Name: Next Expanded Instance Date

Read Only
occurrences Edm.Int32

Number of appointment occurrences in a recurring appointment series.

Display Name: Occurrences

onholdtime Edm.Int32

Shows how long, in minutes, that the record was on hold.

Read Only
outlookownerapptid Edm.Int32

Unique identifier of the Microsoft Office Outlook recurring appointment series owner that correlates to the PR_OWNER_APPT_ID MAPI property.

Display Name: Outlook Recurring Appointment Master Owner

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

patternenddate Edm.DateTimeOffset

End date of the recurrence range.

Display Name: Recurrence Range End

patternendtype Edm.Int32

Select the type of end date for the recurring appointment, such as no end date or the number of occurrences.

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

postponeactivityprocessinguntil Edm.DateTimeOffset

For internal use only.

Read Only
prioritycode Edm.Int32

Priority of the activity.

Display Name: Priority

Default Options
Value Label
0 Low
1 Normal
2 High
processid Edm.Guid

Unique identifier of the Process.

Display Name: Process

recurrencepatterntype Edm.Int32

Select the pattern type for the recurring appointment to indicate whether the appointment occurs daily, weekly, monthly, or yearly.

Display Name: Recurrence Frequency

Default Options
Value Label
0 Daily
1 Weekly
2 Monthly
3 Yearly
scheduleddurationminutes Edm.Int32

Scheduled duration of the activity, specified in minutes.

scheduledend Edm.DateTimeOffset

Scheduled end time of the activity.

Display Name: End Time

scheduledstart Edm.DateTimeOffset

Scheduled start time of the activity.

Display Name: Start Time

senton Edm.DateTimeOffset

Date and time when the activity was sent.

Read Only
seriesid Edm.Guid

Uniqueidentifier specifying the id of recurring series of an instance.

Read Only
seriesstatus Edm.Boolean

Indicates whether the recurring appointment series is active or inactive.

Display Name: Series Status

Default Options
Value Label
1 Active
0 Inactive
sortdate Edm.DateTimeOffset

Shows the date and time by which the activities are sorted.

Display Name: Sort Date

stageid Edm.Guid

Unique identifier of the Stage.

Display Name: (Deprecated) Process Stage

starttime Edm.DateTimeOffset

Start time of the recurring appointment series.

Display Name: Pattern Start Time

statecode Edm.Int32

Status of the activity.

Display Name: Status

Default Options
Value Label
0 Open
1 Completed
2 Canceled
3 Scheduled
statuscode Edm.Int32

Reason for the status of the activity.

Display Name: Status Reason

Default Options
Value Label
1 Free
2 Tentative
3 Completed
4 Canceled
5 Busy
6 Out of Office
subcategory Edm.String

Type a subcategory to identify the recurring appointment type and relate the activity to a specific product, sales region, business group, or other function.

Display Name: Sub-Category

subject Edm.String

Subject associated with the activity.

Display Name: Subject

subscriptionid Edm.Guid

For internal use only.

timezoneruleversionnumber Edm.Int32

For internal use only.

traversedpath Edm.String

For internal use only.

Display Name: (Deprecated) Traversed Path

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the activity.

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

Unique identifier of the user who created the activity.

_createdonbehalfby_value

Unique identifier of the delegate user who created the activitypointer.

_groupid_value

Unique identifier of the recurring appointment series for which the recurrence information was updated.

_modifiedby_value

Unique identifier of user who last modified the activity.

_modifiedonbehalfby_value

Unique identifier of the delegate user who last modified the activitypointer.

_ownerid_value

Unique identifier of the user or team who owns the activity.

_owningbusinessunit_value

Unique identifier of the business unit that owns the activity.

_owningteam_value

Unique identifier of the team that owns the activity.

_owninguser_value

Unique identifier of the user that owns the activity.

_regardingobjectid_value

Unique identifier of the object with which the activity is associated.

_ruleid_value

Unique identifier of the recurrence rule that is associated with the recurring appointment series.

_sendermailboxid_value

Unique identifier of the mailbox associated with the sender of the email message.

_slaid_value

Choose the service level agreement (SLA) that you want to apply to the case record.

_slainvokedid_value

Last SLA that was applied to this case. This field is for internal use only.

_transactioncurrencyid_value

Unique identifier of the currency associated with the activitypointer.

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
activityid_activitypointer activitypointer activity_pointer_recurringappointmentmaster
activityid_recurrencerule recurrencerule recurrencerule_recurringappointmentmaster
createdby systemuser lk_activitypointer_createdby
createdby_recurringappointmentmaster systemuser lk_recurringappointmentmaster_createdby
createdonbehalfby systemuser lk_activitypointer_createdonbehalfby
createdonbehalfby_recurringappointmentmaster systemuser lk_recurringappointmentmaster_createdonbehalfby
modifiedby systemuser lk_activitypointer_modifiedby
modifiedby_recurringappointmentmaster systemuser lk_recurringappointmentmaster_modifiedby
modifiedonbehalfby systemuser lk_activitypointer_modifiedonbehalfby
modifiedonbehalfby_recurringappointmentmaster systemuser lk_recurringappointmentmaster_modifiedonbehalfby
ownerid principal owner_activitypointers
ownerid_recurringappointmentmaster principal owner_recurringappointmentmasters
owningbusinessunit businessunit business_unit_activitypointer
owningbusinessunit_recurringappointmentmaster businessunit business_unit_recurringappointmentmaster_activities
owningteam team team_activity
owningteam_recurringappointmentmaster team team_recurringappointmentmaster
owninguser systemuser user_activity
owninguser_recurringappointmentmaster systemuser user_recurringappointmentmaster
regardingobjectid_account account Account_ActivityPointers
regardingobjectid_account_recurringappointmentmaster account Account_RecurringAppointmentMasters
regardingobjectid_contact contact Contact_ActivityPointers
regardingobjectid_contact_recurringappointmentmaster contact Contact_RecurringAppointmentMasters
regardingobjectid_knowledgearticle knowledgearticle KnowledgeArticle_ActivityPointers
regardingobjectid_knowledgearticle_recurringappointmentmaster knowledgearticle KnowledgeArticle_RecurringAppointmentMasters
regardingobjectid_knowledgebaserecord knowledgebaserecord KnowledgeBaseRecord_ActivityPointers
regardingobjectid_knowledgebaserecord_recurringappointmentmaster knowledgebaserecord KnowledgeBaseRecord_RecurringAppointmentMasters
regardingobjectid_new_interactionforemail interactionforemail new_interactionforemail_ActivityPointers
sendermailboxid mailbox activitypointer_sendermailboxid_mailbox
sla_activitypointer_sla sla manualsla_activitypointer
slainvokedid_activitypointer_sla sla sla_activitypointer
stageid_processstage processstage processstage_recurringappointmentmasters
transactioncurrencyid transactioncurrency TransactionCurrency_ActivityPointer
transactioncurrencyid_recurringappointmentmaster transactioncurrency TransactionCurrency_RecurringAppointmentMaster

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
activity_pointer_activity_mime_attachment activitymimeattachment objectid_activitypointer
activity_pointer_appointment appointment activityid_activitypointer
activity_pointer_email email activityid_activitypointer
activity_pointer_fax fax activityid_activitypointer
activity_pointer_letter letter activityid_activitypointer
activity_pointer_phonecall phonecall activityid_activitypointer
activity_pointer_recurrencerule recurrencerule objectid
activity_pointer_recurringappointmentmaster recurringappointmentmaster activityid_activitypointer
activity_pointer_socialactivity socialactivity activityid_activitypointer
activity_pointer_task task activityid_activitypointer
activitypointer_activity_parties activityparty activityid_activitypointer
ActivityPointer_AsyncOperations asyncoperation regardingobjectid_activitypointer
ActivityPointer_BulkDeleteFailures bulkdeletefailure regardingobjectid_activitypointer
activitypointer_connections1 connection record1id_activitypointer
activitypointer_connections2 connection record2id_activitypointer
ActivityPointer_QueueItem queueitem objectid_activitypointer
recurringappointmentmaster_actioncard actioncard regardingobjectid_recurringappointmentmaster_actioncard
recurringappointmentmaster_activity_parties activityparty activityid_recurringappointmentmaster
RecurringAppointmentMaster_Annotation annotation objectid_recurringappointmentmaster
recurringappointmentmaster_appointment appointment seriesid_recurringappointmentmaster
RecurringAppointmentMaster_AsyncOperations asyncoperation regardingobjectid_recurringappointmentmaster
RecurringAppointmentMaster_BulkDeleteFailures bulkdeletefailure regardingobjectid_recurringappointmentmaster
recurringappointmentmaster_connections1 connection record1id_recurringappointmentmaster
recurringappointmentmaster_connections2 connection record2id_recurringappointmentmaster
RecurringAppointmentMaster_DuplicateBaseRecord duplicaterecord baserecordid_recurringappointmentmaster
RecurringAppointmentMaster_DuplicateMatchingRecord duplicaterecord duplicaterecordid_recurringappointmentmaster
recurringappointmentmaster_PostFollows postfollow regardingobjectid_recurringappointmentmaster
recurringappointmentmaster_PostRegardings postregarding regardingobjectid_recurringappointmentmaster
recurringappointmentmaster_principalobjectattributeaccess principalobjectattributeaccess objectid_recurringappointmentmaster
RecurringAppointmentMaster_ProcessSessions processsession regardingobjectid_recurringappointmentmaster
RecurringAppointmentMaster_QueueItem queueitem objectid_recurringappointmentmaster
RecurringAppointmentMaster_SyncErrors syncerror regardingobjectid_recurringappointmentmaster_syncerror
slakpiinstance_activitypointer slakpiinstance regarding_activitypointer

Operations

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

Name Binding
AddRecurrence Not Bound
Book Not Bound
CreateException Collection
CreateInstance Not Bound
DeleteOpenInstances Not Bound
GrantAccess Not Bound
ModifyAccess Not Bound
Reschedule Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the recurringappointmentmaster entity type.

Name Description
Activities Patch Patch for Dynamics 365 workload for activities.
Application Common For internal use only.
System Solution Internal CRM System Solution

See also