ServiceAppointment Entity Metadata

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the service appointment entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class for this entity is ServiceAppointment.

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the Metadata for Your Organization.

In This Topic

Entity Metadata

Privilege Metadata

Attribute Metadata

One-to-Many Relationships

Many-to-Many Relationships

Many-to-One Relationships

Entity Metadata

The following table shows the metadata for the service appointment entity.

Entity metadata property Value

OTC

4214

EntityLogicalName

serviceappointment

DisplayName

Service Activity

OwnershipType

UserOwned

IsCustomizable

True

Description

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

IsAvailableOffline

True

IsAuditEnabled

False

AutoRouteToOwnerQueue

False

CanBeInManyToMany

True

CanBePrimaryEntityInRelationship

True

CanBeRelatedEntityInRelationship

True

CanCreateAttributes

True

CanCreateCharts

True

CanCreateForms

True

CanCreateViews

True

CanModifyAdditionalSettings

True

CanTriggerWorkflow

True

IsActivity

True

IsActivityParty

False

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

False

IsEnabledForCharts

True

IsImportable

True

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

True

IsVisibleInMobile

False

PrimaryIdAttribute

activityid

PrimaryNameAttribute

subject

ReportViewName

FilteredServiceAppointment

RecurrenceBaseEntityLogicalName

DisplayCollectionName

Service Activities

Privilege Metadata

The following table shows the entity privilege metadata for the service appointment entity.

EntityLogicalName OTC PrivilegeName Id Type CanBeBasic CanBeDeep CanBeGlobal CanBeLocal

serviceappointment

4214

prvAppendActivity

78777c10-09ab-4326-b4c8-cf5729702937

Append

True

True

True

True

serviceappointment

4214

prvAppendToActivity

6ec8e901-d770-44c0-8f12-d07425f638bd

AppendTo

True

True

True

True

serviceappointment

4214

prvAssignActivity

8b99344e-ebbf-4f84-8438-e1e34d194de9

Assign

True

True

True

True

serviceappointment

4214

prvCreateActivity

091df793-fe5e-44d4-b4ca-7e3f580c4664

Create

True

True

True

True

serviceappointment

4214

prvDeleteActivity

bb4457f2-9b45-4482-a95a-7adef25f388a

Delete

True

True

True

True

serviceappointment

4214

prvReadActivity

650c14fe-3521-45fe-a000-84138688e45d

Read

True

True

True

True

serviceappointment

4214

prvShareActivity

b5f2ee06-d359-4495-bbda-312aae1c6b1e

Share

True

True

True

True

serviceappointment

4214

prvWriteActivity

0dc8f72c-57d5-4b4d-8892-fe6aac0e4b81

Write

True

True

True

True

Attribute Metadata

The following table shows the attribute metadata for the service appointment entity.

EntityLogicalName IsCustomizableEntity IsIntersect LogicalName Description Type SchemaName IsCustomAttribute IsCustomizable RequiredLevel IsValidForCreate IsValidForRead IsValidForUpdate CanBeSecuredForCreate CanBeSecuredForRead CanBeSecuredForUpdate IsAuditEnabled IsManaged IsPrimaryId IsPrimaryName IsRenameable IsSecured IsValidForAdvancedFind DisplayName

serviceappointment

yes

no

activityid

Unique identifier of the service activity.

Uniqueidentifier

ActivityId

False

True

SystemRequired

True

True

False

False

False

False

False

True

True

False

True

False

True

Service Activity

serviceappointment

yes

no

activitytypecode

Type of activity.

EntityName

ActivityTypeCode

False

True

SystemRequired

False

True

False

False

False

False

True

True

False

False

True

False

True

Activity Type

serviceappointment

yes

no

actualdurationminutes

Actual duration of the service activity in minutes.

Integer

ActualDurationMinutes

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Actual Duration

serviceappointment

yes

no

actualend

Actual end time of the service activity.

DateTime

ActualEnd

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Actual End

serviceappointment

yes

no

actualstart

Actual start time of the service activity.

DateTime

ActualStart

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Actual Start

serviceappointment

yes

no

category

Category of the service activity.

String

Category

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Category

serviceappointment

yes

no

createdby

Unique identifier of the user who created the service activity.

Lookup

CreatedBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Created By

serviceappointment

yes

no

createdon

Date and time when the service activity was created.

DateTime

CreatedOn

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Created On

serviceappointment

yes

no

createdonbehalfby

Unique identifier of the delegate user who created the serviceappointment.

Lookup

CreatedOnBehalfBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Created By (Delegate)

serviceappointment

yes

no

customers

Customers for whom the service activity is performed.

PartyList

Customers

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

False

Customers

serviceappointment

yes

no

description

Description of the service activity.

Memo

Description

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Description

serviceappointment

yes

no

exchangerate

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

Decimal

ExchangeRate

False

True

None

False

True

False

False

False

False

True

True

False

False

True

False

True

Exchange Rate

serviceappointment

yes

no

importsequencenumber

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

Integer

ImportSequenceNumber

False

True

None

True

True

False

False

False

False

True

True

False

False

True

False

True

Import Sequence Number

serviceappointment

yes

no

isalldayevent

Information which specifies if the service activity is an all day event.

Boolean

IsAllDayEvent

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

All Day Event

serviceappointment

yes

no

isbilled

Information which specifies whether the service activity was billed as part of resolving a case.

Boolean

IsBilled

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Is Billed

serviceappointment

yes

no

isregularactivity

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

Boolean

IsRegularActivity

False

True

SystemRequired

False

True

False

False

False

False

True

True

False

False

True

False

True

Is Regular Activity

serviceappointment

yes

no

isworkflowcreated

Information which specifies if the service activity was created from a workflow rule.

Boolean

IsWorkflowCreated

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Is Workflow Created

serviceappointment

yes

no

location

Location where the service activity is to occur.

String

Location

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Delivery Location

serviceappointment

yes

no

modifiedby

Unique identifier of the user who last modified the service activity.

Lookup

ModifiedBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Modified By

serviceappointment

yes

no

modifiedon

Date and time when the service activity was last modified.

DateTime

ModifiedOn

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Modified On

serviceappointment

yes

no

modifiedonbehalfby

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

Lookup

ModifiedOnBehalfBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Modified By (Delegate)

serviceappointment

yes

no

overriddencreatedon

Date and time that the record was migrated.

DateTime

OverriddenCreatedOn

False

True

None

True

True

False

False

False

False

True

True

False

False

True

False

True

Record Created On

serviceappointment

yes

no

ownerid

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

Owner

OwnerId

False

True

SystemRequired

True

True

False

False

False

False

True

True

False

False

True

False

True

Owner

serviceappointment

yes

no

owningbusinessunit

Unique identifier of the business unit that owns the service activity.

Lookup

OwningBusinessUnit

False

True

None

False

True

False

False

False

False

False

True

False

False

False

False

False

Owning Business Unit

serviceappointment

yes

no

owningteam

Unique identifier of the team that owns the service activity.

Lookup

OwningTeam

False

True

None

False

True

False

False

False

False

False

True

False

False

False

False

False

Owning Team

serviceappointment

yes

no

owninguser

Unique identifier of the user that owns the service activity.

Lookup

OwningUser

False

True

None

False

True

False

False

False

False

False

True

False

False

False

False

False

Owning User

serviceappointment

yes

no

prioritycode

Priority of the service activity.

Picklist

PriorityCode

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Priority

serviceappointment

yes

no

regardingobjectid

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

Lookup

RegardingObjectId

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Regarding

serviceappointment

yes

no

resources

Users or facility/equipment that are required for the service activity.

PartyList

Resources

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

False

Resources

serviceappointment

yes

no

scheduleddurationminutes

Scheduled duration of the service activity, specified in minutes.

Integer

ScheduledDurationMinutes

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Scheduled Duration

serviceappointment

yes

no

scheduledend

Scheduled end time of the service activity.

DateTime

ScheduledEnd

False

True

ApplicationRequired

True

True

True

False

False

False

True

True

False

False

True

False

True

Scheduled End

serviceappointment

yes

no

scheduledstart

Scheduled start time of the service activity.

DateTime

ScheduledStart

False

True

ApplicationRequired

True

True

True

False

False

False

True

True

False

False

True

False

True

Scheduled Start

serviceappointment

yes

no

serviceid

Unique identifier for an associated service.

Lookup

ServiceId

False

True

ApplicationRequired

True

True

True

False

False

False

True

True

False

False

True

False

True

Service

serviceappointment

yes

no

siteid

Site where the service activity is located.

Lookup

SiteId

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Site

serviceappointment

yes

no

statecode

Status of the service activity.

State

StateCode

False

True

SystemRequired

False

True

False

False

False

False

True

True

False

False

True

False

True

Status

serviceappointment

yes

no

statuscode

Reason for the status of the service activity.

Status

StatusCode

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Status Reason

serviceappointment

yes

no

subcategory

Sub-category of the activity.

String

Subcategory

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Sub-Category

serviceappointment

yes

no

subject

Subject associated with the service activity.

String

Subject

False

True

ApplicationRequired

True

True

True

False

False

False

True

True

False

True

True

False

True

Subject

serviceappointment

yes

no

subscriptionid

For internal use only.

Uniqueidentifier

SubscriptionId

False

False

None

True

False

False

False

False

False

False

True

False

False

False

False

False

Subscription

serviceappointment

yes

no

timezoneruleversionnumber

For internal use only.

Integer

TimeZoneRuleVersionNumber

False

True

None

True

True

True

False

False

False

False

True

False

False

False

False

False

Time Zone Rule Version Number

serviceappointment

yes

no

transactioncurrencyid

Unique identifier of the currency associated with the serviceappointment.

Lookup

TransactionCurrencyId

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Currency

serviceappointment

yes

no

utcconversiontimezonecode

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

Integer

UTCConversionTimeZoneCode

False

True

None

True

True

True

False

False

False

False

True

False

False

False

False

False

UTC Conversion Time Zone Code

serviceappointment

yes

no

versionnumber

Version number of the service activity.

BigInt

VersionNumber

False

False

None

False

True

False

False

False

False

False

True

False

False

False

False

False

Version Number

One-to-Many Relationships

The following table shows the entities that are the referencing entity in a one-to-many relationship with the service appointment entity.

Relationship schema name Referencing entity

serviceappointment_activity_parties

activityparty

ServiceAppointment_Annotation

annotation

ServiceAppointment_AsyncOperations

asyncoperation

ServiceAppointment_BulkDeleteFailures

bulkdeletefailure

serviceappointment_connections2

connection

serviceappointment_connections1

connection

serviceappointment_principalobjectattributeaccess

principalobjectattributeaccess

ServiceAppointment_ProcessSessions

processsession

ServiceAppointment_QueueItem

queueitem

userentityinstancedata_serviceappointment

userentityinstancedata

Many-to-Many Relationships

There are no many-to-many relationships for the service appointment entity.

Many-to-One Relationships

The following table shows the entities that are the referenced entity in a many-to-one relationship with the service appointment entity.

Relationship schema name Referenced entity

Account_ServiceAppointments

account

activity_pointer_service_appointment

activitypointer

business_unit_service_appointments

businessunit

Campaign_ServiceAppointments

campaign

Contact_ServiceAppointments

contact

Contract_ServiceAppointments

contract

Incident_ServiceAppointments

incident

Invoice_ServiceAppointments

invoice

Lead_ServiceAppointments

lead

Opportunity_ServiceAppointments

opportunity

Quote_ServiceAppointments

quote

SalesOrder_ServiceAppointments

salesorder

service_service_appointments

service

site_service_appointments

site

lk_serviceappointment_modifiedonbehalfby

systemuser

lk_serviceappointment_createdonbehalfby

systemuser

lk_serviceappointment_createdby

systemuser

lk_serviceappointment_modifiedby

systemuser

system_user_service_appointments

systemuser

team_service_appointments

team

TransactionCurrency_ServiceAppointment

transactioncurrency

msdyn_postalbum_ServiceAppointments

msdyn_postalbum

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

ServiceAppointment Entity Messages and Methods
ServiceAppointment (Service Activity) Entity Privileges

Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.