appointment EntityType
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Description: Commitment representing a time interval with start/end times and duration.
Entity Set path:[organization URI]/api/data/v8.2/appointments
Base Type: activitypointer EntityType
Display Name: Appointment
Primary Key: activityid
Primary Name Attribute: subject
Properties
Lookup Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to appointment
Operations using the appointment entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
Name |
Type |
Details |
|---|---|---|
activityadditionalparams |
Edm.String |
Description: Additional information provided by the external application as JSON. For internal use only. Display Name: Additional Parameters Inherited from: activitypointer EntityType |
activityid |
Edm.Guid |
Description: Unique identifier of the activity. Display Name: Appointment Inherited from: activitypointer EntityType |
activitytypecode |
Edm.String |
Description: Type of activity. Display Name: Activity Type Read-only property Inherited from: activitypointer EntityType |
actualdurationminutes |
Edm.Int32 |
Description: Actual duration of the activity in minutes. Display Name: Actual Duration Inherited from: activitypointer EntityType |
actualend |
Edm.DateTimeOffset |
Description: Actual end time of the activity. Display Name: Actual End Inherited from: activitypointer EntityType |
actualstart |
Edm.DateTimeOffset |
Description: Actual start time of the activity. Display Name: Actual Start Inherited from: activitypointer EntityType |
attachmenterrors |
Edm.Int32 |
Description: Select the error code to identify issues with the outlook item recipients or attachments, such as blocked attachments. Default Options: 0 : None Display Name: AttachmentErrors |
category |
Edm.String |
Description: 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 |
Description: Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only. Inherited from: activitypointer EntityType |
createdon |
Edm.DateTimeOffset |
Description: Date and time when the activity was created. Display Name: Created On Read-only property Inherited from: activitypointer EntityType |
deliverylastattemptedon |
Edm.DateTimeOffset |
Description: Date and time when the delivery of the activity was last attempted. Read-only property Inherited from: activitypointer EntityType |
deliveryprioritycode |
Edm.Int32 |
Description: Priority of delivery of the activity to the email server. Inherited from: activitypointer EntityType |
description |
Edm.String |
Description: Description of the activity. Display Name: Description Inherited from: activitypointer EntityType |
exchangeitemid |
Edm.String |
Description: The message id of activity which is returned from Exchange Server. Inherited from: activitypointer EntityType |
exchangerate |
Edm.Decimal |
Description: Exchange rate for the currency associated with the activitypointer with respect to the base currency. Display Name: Exchange Rate Read-only property Inherited from: activitypointer EntityType |
exchangeweblink |
Edm.String |
Description: Shows the web link of Activity of type email. Inherited from: activitypointer EntityType |
globalobjectid |
Edm.String |
Description: 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 |
Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
instancetypecode |
Edm.Int32 |
Description: Type of instance of a recurring series. Default Options: 0 : Not Recurring Display Name: Appointment Type Read-only property Inherited from: activitypointer EntityType |
isalldayevent |
Edm.Boolean |
Description: Select whether the appointment is an all-day event to make sure that the required resources are scheduled for the full day. Default Options: 1 : Yes Display Name: All Day Event |
isbilled |
Edm.Boolean |
Description: Information regarding whether the activity was billed as part of resolving a case. Default Options: 1 : Yes Display Name: Is Billed Inherited from: activitypointer EntityType |
ismapiprivate |
Edm.Boolean |
Description: For internal use only. Default Options: 1 : Yes Display Name: Is Private Inherited from: activitypointer EntityType |
isregularactivity |
Edm.Boolean |
Description: Information regarding whether the activity is a regular activity type or event type. Default Options: 1 : Yes Display Name: Is Regular Activity Read-only property Inherited from: activitypointer EntityType |
isworkflowcreated |
Edm.Boolean |
Description: Information regarding whether the activity was created from a workflow rule. Default Options: 1 : Yes Display Name: Is Workflow Created Inherited from: activitypointer EntityType |
lastonholdtime |
Edm.DateTimeOffset |
Description: Contains the date and time stamp of the last on hold time. Display Name: Last On Hold Time Inherited from: activitypointer EntityType |
leftvoicemail |
Edm.Boolean |
Description: Left the voice mail Inherited from: activitypointer EntityType |
location |
Edm.String |
Description: Type the location where the appointment will take place, such as a conference room or customer office. Display Name: Location |
modifiedfieldsmask |
Edm.String |
Description: For internal use only. Display Name: Modified Fields Mask Read-only property |
modifiedon |
Edm.DateTimeOffset |
Description: Date and time when activity was last modified. Display Name: Modified On Read-only property Inherited from: activitypointer EntityType |
onholdtime |
Edm.Int32 |
Description: Shows how long, in minutes, that the record was on hold. Display Name: On Hold Time (Minutes) Read-only property Inherited from: activitypointer EntityType |
originalstartdate |
Edm.DateTimeOffset |
Description: The original start date of the appointment. Display Name: Original Start Date Read-only property |
outlookownerapptid |
Edm.Int32 |
Description: 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 |
Description: Date and time that the record was migrated. Display Name: Record Created On |
postponeactivityprocessinguntil |
Edm.DateTimeOffset |
Description: For internal use only. Read-only property Inherited from: activitypointer EntityType |
prioritycode |
Edm.Int32 |
Description: Priority of the activity. Default Options: 0 : Low Display Name: Priority Inherited from: activitypointer EntityType |
processid |
Edm.Guid |
Description: Unique identifier of the Process. Display Name: Process Inherited from: activitypointer EntityType |
scheduleddurationminutes |
Edm.Int32 |
Description: Scheduled duration of the activity, specified in minutes. Display Name: Duration Inherited from: activitypointer EntityType |
scheduledend |
Edm.DateTimeOffset |
Description: Scheduled end time of the activity. Display Name: End Time Inherited from: activitypointer EntityType |
scheduledstart |
Edm.DateTimeOffset |
Description: Scheduled start time of the activity. Display Name: Start Time Inherited from: activitypointer EntityType |
senton |
Edm.DateTimeOffset |
Description: Date and time when the activity was sent. Read-only property Inherited from: activitypointer EntityType |
seriesid |
Edm.Guid |
Description: Uniqueidentifier specifying the id of recurring series of an instance. Display Name: Series Id Read-only property Inherited from: activitypointer EntityType |
sortdate |
Edm.DateTimeOffset |
Description: Shows the date and time by which the activities are sorted. Display Name: Sort Date Inherited from: activitypointer EntityType |
stageid |
Edm.Guid |
Description: Unique identifier of the Stage. Display Name: Process Stage Inherited from: activitypointer EntityType |
statecode |
Edm.Int32 |
Description: Status of the activity. Default Options: 0 : Open Display Name: Status Inherited from: activitypointer EntityType |
statuscode |
Edm.Int32 |
Description: Reason for the status of the activity. Default Options: 1 : Free Display Name: Status Reason Inherited from: activitypointer EntityType |
subcategory |
Edm.String |
Description: 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 |
Description: Subject associated with the activity. Display Name: Subject Inherited from: activitypointer EntityType |
subscriptionid |
Edm.Guid |
Description: For internal use only. Display Name: Subscription |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. Display Name: Time Zone Rule Version Number Inherited from: activitypointer EntityType |
traversedpath |
Edm.String |
Description: For internal use only. Display Name: Traversed Path Inherited from: activitypointer EntityType |
utcconversiontimezonecode |
Edm.Int32 |
Description: Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code Inherited from: activitypointer EntityType |
versionnumber |
Edm.Int64 |
Description: Version number of the activity. Display Name: Version Number Read-only property Inherited from: activitypointer EntityType |
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. |
|
_serviceid_value |
Unique identifier of an associated service. |
|
_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 |
activity_pointer_appointment |
|
createdby |
lk_activitypointer_createdby |
|
createdby_appointment |
lk_appointment_createdby |
|
createdonbehalfby |
lk_activitypointer_createdonbehalfby |
|
createdonbehalfby_appointment |
lk_appointment_createdonbehalfby |
|
modifiedby |
lk_activitypointer_modifiedby |
|
modifiedby_appointment |
lk_appointment_modifiedby |
|
modifiedonbehalfby |
lk_activitypointer_modifiedonbehalfby |
|
modifiedonbehalfby_appointment |
lk_appointment_modifiedonbehalfby |
|
ownerid |
owner_activitypointers |
|
owningbusinessunit |
business_unit_activitypointer |
|
owningbusinessunit_appointment |
business_unit_appointment_activities |
|
owningteam |
team_activity |
|
owningteam_appointment |
team_appointment |
|
owninguser |
user_activity |
|
owninguser_appointment |
user_appointment |
|
regardingobjectid_account |
Account_ActivityPointers |
|
regardingobjectid_account_appointment |
Account_Appointments |
|
regardingobjectid_bookableresourcebooking |
bookableresourcebooking_ActivityPointers |
|
regardingobjectid_bookableresourcebooking_appointment |
bookableresourcebooking_Appointments |
|
regardingobjectid_bookableresourcebookingheader |
bookableresourcebookingheader_ActivityPointers |
|
regardingobjectid_bookableresourcebookingheader_appointment |
bookableresourcebookingheader_Appointments |
|
regardingobjectid_bulkoperation |
BulkOperation_ActivityPointers |
|
regardingobjectid_bulkoperation_appointment |
BulkOperation_Appointment |
|
regardingobjectid_campaign |
Campaign_ActivityPointers |
|
regardingobjectid_campaign_appointment |
Campaign_Appointments |
|
regardingobjectid_campaignactivity |
CampaignActivity_ActivityPointers |
|
regardingobjectid_campaignactivity_appointment |
CampaignActivity_Appointments |
|
regardingobjectid_contact |
Contact_ActivityPointers |
|
regardingobjectid_contact_appointment |
Contact_Appointments |
|
regardingobjectid_contract |
Contract_ActivityPointers |
|
regardingobjectid_contract_appointment |
Contract_Appointments |
|
regardingobjectid_entitlement |
entitlement_ActivityPointers |
|
regardingobjectid_entitlement_appointment |
entitlement_Appointments |
|
regardingobjectid_entitlementtemplate |
entitlementtemplate_ActivityPointers |
|
regardingobjectid_entitlementtemplate_appointment |
entitlementtemplate_Appointments |
|
regardingobjectid_incident |
Incident_ActivityPointers |
|
regardingobjectid_incident_appointment |
Incident_Appointments |
|
regardingobjectid_invoice |
Invoice_ActivityPointers |
|
regardingobjectid_invoice_appointment |
Invoice_Appointments |
|
regardingobjectid_knowledgearticle |
KnowledgeArticle_ActivityPointers |
|
regardingobjectid_knowledgearticle_appointment |
KnowledgeArticle_Appointments |
|
regardingobjectid_knowledgebaserecord |
KnowledgeBaseRecord_ActivityPointers |
|
regardingobjectid_knowledgebaserecord_appointment |
KnowledgeBaseRecord_Appointments |
|
regardingobjectid_lead |
Lead_ActivityPointers |
|
regardingobjectid_lead_appointment |
Lead_Appointments |
|
regardingobjectid_new_interactionforemail |
new_interactionforemail_ActivityPointers |
|
regardingobjectid_opportunity |
Opportunity_ActivityPointers |
|
regardingobjectid_opportunity_appointment |
Opportunity_Appointments |
|
regardingobjectid_quote |
Quote_ActivityPointers |
|
regardingobjectid_quote_appointment |
Quote_Appointments |
|
regardingobjectid_salesorder |
SalesOrder_ActivityPointers |
|
regardingobjectid_salesorder_appointment |
SalesOrder_Appointments |
|
sendermailboxid |
activitypointer_sendermailboxid_mailbox |
|
seriesid_recurringappointmentmaster |
recurringappointmentmaster_appointment |
|
serviceid |
service_activity_pointers |
|
serviceid_appointment |
service_appointments |
|
sla_activitypointer_sla |
manualsla_activitypointer |
|
sla_appointment_sla |
manualsla_appointment |
|
slainvokedid_activitypointer_sla |
sla_activitypointer |
|
slainvokedid_appointment_sla |
sla_appointment |
|
stageid_processstage |
processstage_appointments |
|
transactioncurrencyid |
TransactionCurrency_ActivityPointer |
|
transactioncurrencyid_appointment |
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_campaignresponse |
originatingactivityid_activitypointer |
|
activity_pointer_activity_mime_attachment |
objectid_activitypointer |
|
activity_pointer_appointment |
activityid_activitypointer |
|
activity_pointer_BulkOperation |
activityid_activitypointer |
|
activity_pointer_BulkOperation_logs |
bulkoperationid_activitypointer |
|
activity_pointer_campaignactivity |
activityid_activitypointer |
|
activity_pointer_campaignresponse |
activityid_activitypointer |
|
activity_pointer_email |
activityid_activitypointer |
|
activity_pointer_fax |
activityid_activitypointer |
|
activity_pointer_incident_resolution |
activityid_activitypointer |
|
activity_pointer_letter |
activityid_activitypointer |
|
activity_pointer_opportunity_close |
activityid_activitypointer |
|
activity_pointer_order_close |
activityid_activitypointer |
|
activity_pointer_phonecall |
activityid_activitypointer |
|
activity_pointer_quote_close |
activityid_activitypointer |
|
activity_pointer_recurringappointmentmaster |
activityid_activitypointer |
|
activity_pointer_service_appointment |
activityid_activitypointer |
|
activity_pointer_socialactivity |
activityid_activitypointer |
|
activity_pointer_task |
activityid_activitypointer |
|
activitypointer_activity_parties |
activityid_activitypointer |
|
ActivityPointer_AsyncOperations |
regardingobjectid_activitypointer |
|
ActivityPointer_BulkDeleteFailures |
regardingobjectid_activitypointer |
|
ActivityPointer_CampaignActivityItems |
campaignactivityid |
|
activitypointer_connections1 |
record1id_activitypointer |
|
activitypointer_connections2 |
record2id_activitypointer |
|
ActivityPointer_QueueItem |
objectid_activitypointer |
|
appointment_actioncard |
regardingobjectid_appointment_actioncard |
|
appointment_activity_mime_attachment |
objectid_appointment |
|
appointment_activity_parties |
activityid_appointment |
|
Appointment_Annotation |
objectid_appointment |
|
Appointment_AsyncOperations |
regardingobjectid_appointment |
|
Appointment_BulkDeleteFailures |
regardingobjectid_appointment |
|
appointment_campaignresponse |
originatingactivityid_appointment |
|
appointment_connections1 |
record1id_appointment |
|
appointment_connections2 |
record2id_appointment |
|
Appointment_DuplicateBaseRecord |
baserecordid_appointment |
|
Appointment_DuplicateMatchingRecord |
duplicaterecordid_appointment |
|
appointment_PostFollows |
regardingobjectid_appointment |
|
appointment_PostRegardings |
regardingobjectid_appointment |
|
Appointment_QueueItem |
objectid_appointment |
|
Appointment_SyncErrors |
regardingobjectid_appointment_syncerror |
|
CreatedActivity_BulkOperationLogs |
createdobjectid_activitypointer |
|
slakpiinstance_activitypointer |
regarding_activitypointer |
|
slakpiinstance_appointment |
regarding_appointment |
Operations bound to appointment
The following operations are bound to the appointment entity type.
Name |
Bound to |
|---|---|
Entity |
Operations using the appointment entity type.
The following operations use the appointment entity type in a parameter or return type.
Name |
How used |
Description |
|---|---|---|
entity Parameter |
Adds recurrence information to an existing appointment. |
|
Target Parameter |
Creates an exception for the recurring appointment instance. |
See Also
Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright