Share via


serviceappointment EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Activity offered by the organization to satisfy its customer's needs. Each service activity includes date, time, duration, and required resources.

Entity Set path:[organization URI]/api/data/v8.2/serviceappointments

Base Type: activitypointer EntityType

Display Name: Service Activity

Primary Key: activityid

Primary Name Attribute: subject

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

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: Service Activity

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

category

Edm.String

Description: Type a category to identify the service activity type, such as routine maintenance or service call, to tie the service activity 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

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.

Read-only property

Inherited from: activitypointer EntityType

isalldayevent

Edm.Boolean

Description: Select whether the service activity is an all-day event to make sure the required resources are scheduled for the full day.

Default Options:

1 : Yes
0 : No

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
0 : No

Display Name: Is Billed

Inherited from: activitypointer EntityType

ismapiprivate

Edm.Boolean

Description: For internal use only.

Default Options:

1 : Yes
0 : No

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
0 : No

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
0 : No

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 service activity will take place, such as a conference room, customer office, or other venue.

Display Name: Delivery Location

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

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
1 : Normal
2 : High

Display Name: Priority

Inherited from: activitypointer EntityType

processid

Edm.Guid

Description: Unique identifier of the Process.

Inherited from: activitypointer EntityType

scheduleddurationminutes

Edm.Int32

Description: Scheduled duration of the activity, specified in minutes.

Display Name: Scheduled Duration

Inherited from: activitypointer EntityType

scheduledend

Edm.DateTimeOffset

Description: Scheduled end time of the activity.

Display Name: Scheduled End

Inherited from: activitypointer EntityType

scheduledstart

Edm.DateTimeOffset

Description: Scheduled start time of the activity.

Display Name: Scheduled Start

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.

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.

Inherited from: activitypointer EntityType

statecode

Edm.Int32

Description: Status of the activity.

Default Options:

0 : Open
1 : Closed
2 : Canceled
3 : Scheduled

Display Name: Status

Inherited from: activitypointer EntityType

statuscode

Edm.Int32

Description: Reason for the status of the activity.

Default Options:

1 : Requested
2 : Tentative
3 : Pending
4 : Reserved
6 : In Progress
7 : Arrived
8 : Completed
9 : Canceled
10 : No Show

Display Name: Status Reason

Inherited from: activitypointer EntityType

subcategory

Edm.String

Description: Type a subcategory to identify the service activity type and relate the activity to a specific product, service 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.

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.

_siteid_value

siteid

Choose the site or location where the service activity will be performed.

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

activity_pointer_service_appointment

createdby

systemuser EntityType

lk_activitypointer_createdby

createdby_serviceappointment

systemuser EntityType

lk_serviceappointment_createdby

createdonbehalfby

systemuser EntityType

lk_activitypointer_createdonbehalfby

createdonbehalfby_serviceappointment

systemuser EntityType

lk_serviceappointment_createdonbehalfby

modifiedby

systemuser EntityType

lk_activitypointer_modifiedby

modifiedby_serviceappointment

systemuser EntityType

lk_serviceappointment_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_activitypointer_modifiedonbehalfby

modifiedonbehalfby_serviceappointment

systemuser EntityType

lk_serviceappointment_modifiedonbehalfby

ownerid

principal EntityType

owner_activitypointers

owningbusinessunit

businessunit EntityType

business_unit_activitypointer

owningbusinessunit_serviceappointment

businessunit EntityType

business_unit_service_appointments

owningteam

team EntityType

team_activity

owningteam_serviceappointment

team EntityType

team_service_appointments

owninguser

systemuser EntityType

user_activity

owninguser_serviceappointment

systemuser EntityType

system_user_service_appointments

regardingobjectid_account

account EntityType

Account_ActivityPointers

regardingobjectid_account_serviceappointment

account EntityType

Account_ServiceAppointments

regardingobjectid_bookableresourcebooking

bookableresourcebooking EntityType

bookableresourcebooking_ActivityPointers

regardingobjectid_bookableresourcebooking_serviceappointment

bookableresourcebooking EntityType

bookableresourcebooking_ServiceAppointments

regardingobjectid_bookableresourcebookingheader

bookableresourcebookingheader EntityType

bookableresourcebookingheader_ActivityPointers

regardingobjectid_bookableresourcebookingheader_serviceappointment

bookableresourcebookingheader EntityType

bookableresourcebookingheader_ServiceAppointments

regardingobjectid_bulkoperation

bulkoperation EntityType

BulkOperation_ActivityPointers

regardingobjectid_campaign

campaign EntityType

Campaign_ActivityPointers

regardingobjectid_campaign_serviceappointment

campaign EntityType

Campaign_ServiceAppointments

regardingobjectid_campaignactivity

campaignactivity EntityType

CampaignActivity_ActivityPointers

regardingobjectid_contact

contact EntityType

Contact_ActivityPointers

regardingobjectid_contact_serviceappointment

contact EntityType

Contact_ServiceAppointments

regardingobjectid_contract

contract EntityType

Contract_ActivityPointers

regardingobjectid_contract_serviceappointment

contract EntityType

Contract_ServiceAppointments

regardingobjectid_entitlement

entitlement EntityType

entitlement_ActivityPointers

regardingobjectid_entitlement_serviceappointment

entitlement EntityType

entitlement_ServiceAppointments

regardingobjectid_entitlementtemplate

entitlementtemplate EntityType

entitlementtemplate_ActivityPointers

regardingobjectid_entitlementtemplate_serviceappointment

entitlementtemplate EntityType

entitlementtemplate_ServiceAppointments

regardingobjectid_incident

incident EntityType

Incident_ActivityPointers

regardingobjectid_incident_serviceappointment

incident EntityType

Incident_ServiceAppointments

regardingobjectid_invoice

invoice EntityType

Invoice_ActivityPointers

regardingobjectid_invoice_serviceappointment

invoice EntityType

Invoice_ServiceAppointments

regardingobjectid_knowledgearticle

knowledgearticle EntityType

KnowledgeArticle_ActivityPointers

regardingobjectid_knowledgearticle_serviceappointment

knowledgearticle EntityType

KnowledgeArticle_ServiceAppointments

regardingobjectid_knowledgebaserecord

knowledgebaserecord EntityType

KnowledgeBaseRecord_ActivityPointers

regardingobjectid_knowledgebaserecord_serviceappointment

knowledgebaserecord EntityType

KnowledgeBaseRecord_ServiceAppointments

regardingobjectid_lead

lead EntityType

Lead_ActivityPointers

regardingobjectid_lead_serviceappointment

lead EntityType

Lead_ServiceAppointments

regardingobjectid_new_interactionforemail

interactionforemail EntityType

new_interactionforemail_ActivityPointers

regardingobjectid_opportunity

opportunity EntityType

Opportunity_ActivityPointers

regardingobjectid_opportunity_serviceappointment

opportunity EntityType

Opportunity_ServiceAppointments

regardingobjectid_quote

quote EntityType

Quote_ActivityPointers

regardingobjectid_quote_serviceappointment

quote EntityType

Quote_ServiceAppointments

regardingobjectid_salesorder

salesorder EntityType

SalesOrder_ActivityPointers

regardingobjectid_salesorder_serviceappointment

salesorder EntityType

SalesOrder_ServiceAppointments

sendermailboxid

mailbox EntityType

activitypointer_sendermailboxid_mailbox

serviceid

service EntityType

service_activity_pointers

serviceid_serviceappointment

service EntityType

service_service_appointments

siteid

site EntityType

site_service_appointments

sla_activitypointer_sla

sla EntityType

manualsla_activitypointer

SLAId

sla EntityType

manualsla_serviceappointment

slainvokedid_activitypointer_sla

sla EntityType

sla_activitypointer

slainvokedid_serviceappointment_sla

sla EntityType

sla_serviceappointment

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_ActivityPointer

transactioncurrencyid_serviceappointment

transactioncurrency EntityType

TransactionCurrency_ServiceAppointment

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

campaignresponse EntityType

originatingactivityid_activitypointer

activity_pointer_activity_mime_attachment

activitymimeattachment EntityType

objectid_activitypointer

activity_pointer_appointment

appointment EntityType

activityid_activitypointer

activity_pointer_BulkOperation

bulkoperation EntityType

activityid_activitypointer

activity_pointer_BulkOperation_logs

bulkoperationlog EntityType

bulkoperationid_activitypointer

activity_pointer_campaignactivity

campaignactivity EntityType

activityid_activitypointer

activity_pointer_campaignresponse

campaignresponse EntityType

activityid_activitypointer

activity_pointer_email

email EntityType

activityid_activitypointer

activity_pointer_fax

fax EntityType

activityid_activitypointer

activity_pointer_incident_resolution

incidentresolution EntityType

activityid_activitypointer

activity_pointer_letter

letter EntityType

activityid_activitypointer

activity_pointer_opportunity_close

opportunityclose EntityType

activityid_activitypointer

activity_pointer_order_close

orderclose EntityType

activityid_activitypointer

activity_pointer_phonecall

phonecall EntityType

activityid_activitypointer

activity_pointer_quote_close

quoteclose EntityType

activityid_activitypointer

activity_pointer_recurringappointmentmaster

recurringappointmentmaster EntityType

activityid_activitypointer

activity_pointer_service_appointment

serviceappointment EntityType

activityid_activitypointer

activity_pointer_socialactivity

socialactivity EntityType

activityid_activitypointer

activity_pointer_task

task EntityType

activityid_activitypointer

activitypointer_activity_parties

activityparty EntityType

activityid_activitypointer

ActivityPointer_AsyncOperations

asyncoperation EntityType

regardingobjectid_activitypointer

ActivityPointer_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_activitypointer

ActivityPointer_CampaignActivityItems

campaignactivityitem EntityType

campaignactivityid

activitypointer_connections1

connection EntityType

record1id_activitypointer

activitypointer_connections2

connection EntityType

record2id_activitypointer

ActivityPointer_QueueItem

queueitem EntityType

objectid_activitypointer

CreatedActivity_BulkOperationLogs

bulkoperationlog EntityType

createdobjectid_activitypointer

serviceappointment_actioncard

actioncard EntityType

regardingobjectid_serviceappointment_actioncard

serviceappointment_activity_parties

activityparty EntityType

activityid_serviceappointment

ServiceAppointment_Annotation

annotation EntityType

objectid_serviceappointment

ServiceAppointment_AsyncOperations

asyncoperation EntityType

regardingobjectid_serviceappointment

ServiceAppointment_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_serviceappointment

serviceappointment_connections1

connection EntityType

record1id_serviceappointment

serviceappointment_connections2

connection EntityType

record2id_serviceappointment

ServiceAppointment_QueueItem

queueitem EntityType

objectid_serviceappointment

ServiceAppointment_SyncErrors

syncerror EntityType

regardingobjectid_serviceappointment_syncerror

slakpiinstance_activitypointer

slakpiinstance EntityType

regarding_activitypointer

slakpiinstance_serviceappointment

slakpiinstance EntityType

regarding_serviceappointment

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