appointment EntityType
Commitment representing a time interval with start/end times and duration.
- Entity Set Path
- [organization URI]/api/data/v9.2/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 Inherited From: activitypointer |
||||||||||||||
| activityid | Edm.Guid |
Unique identifier of the activity. Display Name: Appointment Inherited From: activitypointer |
||||||||||||||
| activitytypecode | Edm.String |
Type of activity. Display Name: Activity Type Inherited From: activitypointer Read Only
|
||||||||||||||
| actualdurationminutes | Edm.Int32 |
Actual duration of the activity in minutes. Display Name: Actual Duration Inherited From: activitypointer |
||||||||||||||
| actualend | Edm.DateTimeOffset |
Actual end time of the activity. Display Name: Actual End Inherited From: activitypointer |
||||||||||||||
| actualstart | Edm.DateTimeOffset |
Actual start time of the activity. Display Name: Actual Start Inherited From: activitypointer |
||||||||||||||
| attachmenterrors | Edm.Int32 |
Select the error code to identify issues with the outlook item recipients or attachments, such as blocked attachments. Display Name: AttachmentErrors Inherited From: activitypointer
Default Options
|
||||||||||||||
| 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 Inherited From: activitypointer |
||||||||||||||
| community | Edm.Int32 |
Shows how contact about the social activity originated, such as from Twitter or Facebook. This field is read-only. Inherited From: activitypointer |
||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the activity was created. Display Name: Created On Inherited From: activitypointer Read Only
|
||||||||||||||
| deliverylastattemptedon | Edm.DateTimeOffset |
Date and time when the delivery of the activity was last attempted. Inherited From: activitypointer Read Only
|
||||||||||||||
| deliveryprioritycode | Edm.Int32 |
Priority of delivery of the activity to the email server. Inherited From: activitypointer |
||||||||||||||
| description | Edm.String |
Description of the activity. Display Name: Description Inherited From: activitypointer |
||||||||||||||
| descriptionblobid | Edm.Binary |
File that contains description content. Inherited From: activitypointer Read Only
|
||||||||||||||
| descriptionblobid_name | Edm.String |
Inherited From: activitypointer Read Only
|
||||||||||||||
| exchangeitemid | Edm.String |
The message id of activity which is returned from Exchange Server. Inherited From: activitypointer |
||||||||||||||
| exchangerate | Edm.Decimal |
Exchange rate for the currency associated with the activitypointer with respect to the base currency. Display Name: Exchange Rate Inherited From: activitypointer Read Only
|
||||||||||||||
| exchangeweblink | Edm.String |
Shows the web link of Activity of type email. Inherited From: activitypointer |
||||||||||||||
| formattedscheduledend | Edm.DateTimeOffset |
Formatted scheduled end time of the activity. Display Name: Formatted End Date Inherited From: activitypointer Read Only
|
||||||||||||||
| formattedscheduledstart | Edm.DateTimeOffset |
Formatted scheduled start time of the activity. Display Name: Formatted Start Date Inherited From: activitypointer Read Only
|
||||||||||||||
| 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 Inherited From: activitypointer |
||||||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number Inherited From: activitypointer |
||||||||||||||
| instancetypecode | Edm.Int32 |
Type of instance of a recurring series. Display Name: Appointment Type Inherited From: activitypointer Read Only
Default Options
|
||||||||||||||
| 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 Inherited From: activitypointer
Default Options
|
||||||||||||||
| isbilled | Edm.Boolean |
Information regarding whether the activity was billed as part of resolving a case. Display Name: Is Billed Inherited From: activitypointer
Default Options
|
||||||||||||||
| isdraft | Edm.Boolean |
Information regarding whether the appointment is a draft. Display Name: IsDraft Inherited From: activitypointer
Default Options
|
||||||||||||||
| ismapiprivate | Edm.Boolean |
For internal use only. Display Name: Is Private Inherited From: activitypointer
Default Options
|
||||||||||||||
| isonlinemeeting | Edm.Boolean |
Displays whether or not this is an online meeting. Display Name: Is Online Meeting Inherited From: activitypointer
Default Options
|
||||||||||||||
| isregularactivity | Edm.Boolean |
Information regarding whether the activity is a regular activity type or event type. Display Name: Is Regular Activity Inherited From: activitypointer Read Only
Default Options
|
||||||||||||||
| isunsafe | Edm.Int32 |
For internal use only. Display Name: IsUnsafe Inherited From: activitypointer Read Only
|
||||||||||||||
| isworkflowcreated | Edm.Boolean |
Information regarding whether the activity was created from a workflow rule. Display Name: Is Workflow Created Inherited From: activitypointer
Default Options
|
||||||||||||||
| lastonholdtime | Edm.DateTimeOffset |
Contains the date and time stamp of the last on hold time. Display Name: Last On Hold Time Inherited From: activitypointer |
||||||||||||||
| leftvoicemail | Edm.Boolean |
Left the voice mail Inherited From: activitypointer |
||||||||||||||
| location | Edm.String |
Type the location where the appointment will take place, such as a conference room or customer office. Display Name: Location Inherited From: activitypointer |
||||||||||||||
| modifiedfieldsmask | Edm.String |
For internal use only. Display Name: Modified Fields Mask Inherited From: activitypointer Read Only
|
||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when activity was last modified. Display Name: Modified On Inherited From: activitypointer Read Only
|
||||||||||||||
| onholdtime | Edm.Int32 |
Shows how long, in minutes, that the record was on hold. Display Name: On Hold Time (Minutes) Inherited From: activitypointer Read Only
|
||||||||||||||
| onlinemeetingchatid | Edm.String |
Shows the online meeting chat id. Display Name: Online Meeting Chat Id Inherited From: activitypointer |
||||||||||||||
| onlinemeetingid | Edm.String |
Shows the online meeting id. Display Name: Online Meeting Id Inherited From: activitypointer |
||||||||||||||
| onlinemeetingjoinurl | Edm.String |
Shows the online meeting join url. Display Name: Online Meeting Join Url Inherited From: activitypointer |
||||||||||||||
| onlinemeetingtype | Edm.Int32 |
Displays the online meeting type. Display Name: Online Meeting Type Inherited From: activitypointer
Default Options
|
||||||||||||||
| originalstartdate | Edm.DateTimeOffset |
The original start date of the appointment. Display Name: Original Start Date Inherited From: activitypointer 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 Inherited From: activitypointer |
||||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display Name: Record Created On Inherited From: activitypointer |
||||||||||||||
| postponeactivityprocessinguntil | Edm.DateTimeOffset |
For internal use only. Inherited From: activitypointer Read Only
|
||||||||||||||
| prioritycode | Edm.Int32 |
Priority of the activity. Display Name: Priority Inherited From: activitypointer
Default Options
|
||||||||||||||
| processid | Edm.Guid |
Unique identifier of the Process. Display Name: Process Inherited From: activitypointer |
||||||||||||||
| scheduleddurationminutes | Edm.Int32 |
Scheduled duration of the activity, specified in minutes. Display Name: Duration Inherited From: activitypointer |
||||||||||||||
| scheduledend | Edm.DateTimeOffset |
Scheduled end time of the activity. Display Name: End Time Inherited From: activitypointer |
||||||||||||||
| scheduledstart | Edm.DateTimeOffset |
Scheduled start time of the activity. Display Name: Start Time Inherited From: activitypointer |
||||||||||||||
| senton | Edm.DateTimeOffset |
Date and time when the activity was sent. Inherited From: activitypointer Read Only
|
||||||||||||||
| seriesid | Edm.Guid |
Uniqueidentifier specifying the id of recurring series of an instance. Display Name: Series Id Inherited From: activitypointer Read Only
|
||||||||||||||
| sortdate | Edm.DateTimeOffset |
Shows the date and time by which the activities are sorted. Display Name: Sort Date Inherited From: activitypointer |
||||||||||||||
| stageid | Edm.Guid |
Unique identifier of the Stage. Display Name: (Deprecated) Process Stage Inherited From: activitypointer |
||||||||||||||
| statecode | Edm.Int32 |
Status of the activity. Display Name: Status Inherited From: activitypointer
Default Options
|
||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the activity. Display Name: Status Reason Inherited From: activitypointer
Default Options
|
||||||||||||||
| 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 Inherited From: activitypointer |
||||||||||||||
| subject | Edm.String |
Subject associated with the activity. Display Name: Subject Inherited From: activitypointer |
||||||||||||||
| subscriptionid | Edm.Guid |
For internal use only. Display Name: Subscription Inherited From: activitypointer |
||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number Inherited From: activitypointer |
||||||||||||||
| traversedpath | Edm.String |
For internal use only. Display Name: (Deprecated) Traversed Path Inherited From: activitypointer |
||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code Inherited From: activitypointer |
||||||||||||||
| versionnumber | Edm.Int64 |
Version number of the activity. Display Name: Version Number Inherited From: activitypointer 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 Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the activity. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the activitypointer. |
| _modifiedby_value | modifiedby |
Unique identifier of user who last modified the activity. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the activitypointer. |
| _ownerid_value | ownerid |
Unique identifier of the user or team who owns the activity. |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier of the business unit that owns the activity. |
| _owningteam_value | owningteam |
Unique identifier of the team that owns the activity. |
| _owninguser_value | owninguser |
Unique identifier of the user that owns the activity. |
| _regardingobjectid_value | regardingobjectid_account regardingobjectid_adx_invitation regardingobjectid_contact regardingobjectid_knowledgearticle regardingobjectid_knowledgebaserecord regardingobjectid_mspp_adplacement regardingobjectid_mspp_pollplacement regardingobjectid_mspp_publishingstatetransitionrule regardingobjectid_mspp_redirect regardingobjectid_mspp_shortcut regardingobjectid_mspp_website regardingobjectid_new_interactionforemail |
Unique identifier of the object with which the activity is associated. |
| _sendermailboxid_value | sendermailboxid |
Unique identifier of the mailbox associated with the sender of the email message. |
| _slaid_value | sla_activitypointer_sla |
Choose the service level agreement (SLA) that you want to apply to the case record. |
| _slainvokedid_value | slainvokedid_activitypointer_sla |
Last SLA that was applied to this case. This field is for internal use only. |
| _transactioncurrencyid_value | transactioncurrencyid |
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_adx_invitation | adx_invitation | adx_invitation_ActivityPointers |
| regardingobjectid_adx_invitation_appointment | adx_invitation | adx_invitation_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_mspp_adplacement | mspp_adplacement | mspp_adplacement_ActivityPointers |
| regardingobjectid_mspp_adplacement_appointment | mspp_adplacement | mspp_adplacement_Appointments |
| regardingobjectid_mspp_pollplacement | mspp_pollplacement | mspp_pollplacement_ActivityPointers |
| regardingobjectid_mspp_pollplacement_appointment | mspp_pollplacement | mspp_pollplacement_Appointments |
| regardingobjectid_mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule_ActivityPointers |
| regardingobjectid_mspp_publishingstatetransitionrule_appointment | mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule_Appointments |
| regardingobjectid_mspp_redirect | mspp_redirect | mspp_redirect_ActivityPointers |
| regardingobjectid_mspp_redirect_appointment | mspp_redirect | mspp_redirect_Appointments |
| regardingobjectid_mspp_shortcut | mspp_shortcut | mspp_shortcut_ActivityPointers |
| regardingobjectid_mspp_shortcut_appointment | mspp_shortcut | mspp_shortcut_Appointments |
| regardingobjectid_mspp_website | mspp_website | mspp_website_ActivityPointers |
| regardingobjectid_mspp_website_appointment | mspp_website | mspp_website_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_adx_inviteredemption | adx_inviteredemption | activityid_adx_inviteredemption |
| activity_pointer_adx_portalcomment | adx_portalcomment | activityid_adx_portalcomment |
| activity_pointer_appointment | appointment | activityid_activitypointer |
| activity_pointer_chat | chat | activityid_chat |
| activity_pointer_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_FileAttachments | fileattachment | objectid_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 |
|---|---|
| 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 |