appointment EntityType

Commitment representing a time interval with start/end times and duration.

Entity Set Path
[organization URI]/api/data/v9.0/appointments
Base Type
activitypointer
Display Name
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.

Display Name: Additional Parameters

activityid Edm.Guid

Unique identifier of the activity.

Display Name: Appointment

activitytypecode Edm.String

Type of activity.

Display Name: Activity Type

Read Only
actualdurationminutes Edm.Int32

Actual duration of the activity in minutes.

Display Name: Actual Duration

actualend Edm.DateTimeOffset

Actual end time of the activity.

Display Name: Actual End

actualstart Edm.DateTimeOffset

Actual start time of the activity.

Display Name: Actual Start

attachmenterrors Edm.Int32

Select the error code to identify issues with the outlook item recipients or attachments, such as blocked attachments.

Display Name: AttachmentErrors

Default Options
Value Label
0 None
1 The appointment was saved as a Microsoft Dynamics 365 appointment record, but not all the attachments could be saved with it. An attachment cannot be saved if it is blocked or if its file type is invalid.
category Edm.String

Type a category to identify the appointment type, such as sales demo, prospect call, 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
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

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.

globalobjectid Edm.String

Shows the ID of the appointment in Microsoft Office Outlook. The ID is used to synchronize the appointment between Microsoft Dynamics 365 and the correct Exchange account.

Display Name: Outlook Appointment

importsequencenumber Edm.Int32

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

Display Name: Import Sequence Number

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
isalldayevent Edm.Boolean

Select whether the 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
isdraft Edm.Boolean

Information regarding whether the appointment is a draft.

Display Name: IsDraft

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
isonlinemeeting Edm.Boolean

Displays whether or not this is an online meeting.

Display Name: Is Online Meeting

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
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
lastonholdtime Edm.DateTimeOffset

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

Display Name: Last On Hold Time

leftvoicemail Edm.Boolean

Left the voice mail

location Edm.String

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

Display Name: Location

modifiedfieldsmask Edm.String

For internal use only.

Display Name: Modified Fields Mask

Read Only
modifiedon Edm.DateTimeOffset

Date and time when activity was last modified.

Display Name: Modified On

Read Only
onholdtime Edm.Int32

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

Display Name: On Hold Time (Minutes)

Read Only
onlinemeetingchatid Edm.String

Shows the online meeting chat id.

Display Name: Online Meeting Chat Id

onlinemeetingid Edm.String

Shows the online meeting id.

Display Name: Online Meeting Id

onlinemeetingjoinurl Edm.String

Shows the online meeting join url.

Display Name: Online Meeting Join Url

onlinemeetingtype Edm.Int32

Displays the online meeting type.

Display Name: Online Meeting Type

Default Options
Value Label
1 Teams Meeting
originalstartdate Edm.DateTimeOffset

The original start date of the appointment.

Display Name: Original Start Date

Read Only
outlookownerapptid Edm.Int32

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

Display Name: Outlook Appointment Owner

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

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

scheduleddurationminutes Edm.Int32

Scheduled duration of the activity, specified in minutes.

Display Name: Duration

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.

Display Name: Series Id

Read Only
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

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 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.

Display Name: Subscription

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

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.

Display Name: Version Number

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.

_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.

_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_appointment
createdby systemuser lk_activitypointer_createdby
createdby_appointment systemuser lk_appointment_createdby
createdonbehalfby systemuser lk_activitypointer_createdonbehalfby
createdonbehalfby_appointment systemuser lk_appointment_createdonbehalfby
modifiedby systemuser lk_activitypointer_modifiedby
modifiedby_appointment systemuser lk_appointment_modifiedby
modifiedonbehalfby systemuser lk_activitypointer_modifiedonbehalfby
modifiedonbehalfby_appointment systemuser lk_appointment_modifiedonbehalfby
ownerid principal owner_activitypointers
ownerid_appointment principal owner_appointments
owningbusinessunit businessunit business_unit_activitypointer
owningbusinessunit_appointment businessunit business_unit_appointment_activities
owningteam team team_activity
owningteam_appointment team team_appointment
owninguser systemuser user_activity
owninguser_appointment systemuser user_appointment
regardingobjectid_account account Account_ActivityPointers
regardingobjectid_account_appointment account Account_Appointments
regardingobjectid_contact contact Contact_ActivityPointers
regardingobjectid_contact_appointment contact Contact_Appointments
regardingobjectid_knowledgearticle knowledgearticle KnowledgeArticle_ActivityPointers
regardingobjectid_knowledgearticle_appointment knowledgearticle KnowledgeArticle_Appointments
regardingobjectid_knowledgebaserecord knowledgebaserecord KnowledgeBaseRecord_ActivityPointers
regardingobjectid_knowledgebaserecord_appointment knowledgebaserecord KnowledgeBaseRecord_Appointments
regardingobjectid_new_interactionforemail interactionforemail new_interactionforemail_ActivityPointers
sendermailboxid mailbox activitypointer_sendermailboxid_mailbox
seriesid_recurringappointmentmaster recurringappointmentmaster recurringappointmentmaster_appointment
sla_activitypointer_sla sla manualsla_activitypointer
sla_appointment_sla sla manualsla_appointment
slainvokedid_activitypointer_sla sla sla_activitypointer
slainvokedid_appointment_sla sla sla_appointment
stageid_processstage processstage processstage_appointments
transactioncurrencyid transactioncurrency TransactionCurrency_ActivityPointer
transactioncurrencyid_appointment transactioncurrency TransactionCurrency_Appointment

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
appointment_actioncard actioncard regardingobjectid_appointment_actioncard
appointment_activity_mime_attachment activitymimeattachment objectid_appointment
appointment_activity_parties activityparty activityid_appointment
Appointment_Annotation annotation objectid_appointment
Appointment_AsyncOperations asyncoperation regardingobjectid_appointment
Appointment_BulkDeleteFailures bulkdeletefailure regardingobjectid_appointment
appointment_connections1 connection record1id_appointment
appointment_connections2 connection record2id_appointment
Appointment_DuplicateBaseRecord duplicaterecord baserecordid_appointment
Appointment_DuplicateMatchingRecord duplicaterecord duplicaterecordid_appointment
appointment_PostFollows postfollow regardingobjectid_appointment
appointment_PostRegardings postregarding regardingobjectid_appointment
appointment_principalobjectattributeaccess principalobjectattributeaccess objectid_appointment
Appointment_ProcessSessions processsession regardingobjectid_appointment
Appointment_QueueItem queueitem objectid_appointment
Appointment_SyncErrors syncerror regardingobjectid_appointment_syncerror
slakpiinstance_activitypointer slakpiinstance regarding_activitypointer
slakpiinstance_appointment slakpiinstance regarding_appointment

Operations

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

Name Binding
AddRecurrence Entity
Book Not Bound
CreateException Not Bound
GrantAccess Not Bound
ImmediateBook Not Bound
ModifyAccess Not Bound
Reschedule Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
Validate Not Bound
ValidateSavedQuery Not Bound
ValidateUnpublished Not Bound

Solutions

The following solutions include the appointment entity type.

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

See also