Equipment Entity Reference

Resource that can be scheduled.

Added by: Service Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/equipments
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/equipments(equipmentid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/equipments(equipmentid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/equipments
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetBusinessEquipment Microsoft.Dynamics.CRM.SetBusinessEquipment SetBusinessEquipmentRequest
SetBusinessSystemUser SetBusinessSystemUser Action SetBusinessSystemUserRequest
Update PATCH [org URI]/api/data/v9.0/equipments(equipmentid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Equipments
DisplayCollectionName Facilities/Equipment
DisplayName Facility/Equipment
EntitySetName equipments
IsBPFEntity False
LogicalCollectionName equipments
LogicalName equipment
OwnershipType BusinessOwned
PrimaryIdAttribute equipmentid
PrimaryNameAttribute name
SchemaName Equipment

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

BusinessUnitId

Property Value
Description Business Unit Id
DisplayName Business Unit Id
IsValidForForm True
IsValidForRead True
LogicalName businessunitid
RequiredLevel SystemRequired
Targets businessunit
Type Lookup

CalendarId

Property Value
Description Fiscal calendar associated with the facility/equipment.
DisplayName Calendar
IsValidForForm False
IsValidForRead True
LogicalName calendarid
RequiredLevel SystemRequired
Targets calendar
Type Lookup

Description

Property Value
Description Description of the facility/equipment.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

DisplayInServiceViews

Property Value
Description For internal use only.
DisplayName Display in Service Views
IsValidForForm True
IsValidForRead True
LogicalName displayinserviceviews
RequiredLevel None
Type Boolean

DisplayInServiceViews Options

Value Label
1 Yes
0 No

DefaultValue: False

EMailAddress

Property Value
Description Email address of person to contact about the use of the facility/equipment.
DisplayName Primary Email
FormatName Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailaddress
MaxLength 100
RequiredLevel None
Type String

EquipmentId

Property Value
Description Unique identifier of the facility/equipment.
DisplayName Facility/Equipment
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName equipmentid
RequiredLevel SystemRequired
Type Uniqueidentifier

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsDisabled

Property Value
Description Whether the facility/equipment is disabled or operational.
DisplayName Is Disabled
IsValidForForm False
IsValidForRead True
LogicalName isdisabled
RequiredLevel None
Type Boolean

IsDisabled Options

Value Label
1 Yes
0 No

DefaultValue: False

Name

Property Value
Description Name of the facility/equipment.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 160
RequiredLevel SystemRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

SiteId

Property Value
Description Site where the facility/equipment is located.
DisplayName Site
IsValidForForm True
IsValidForRead True
LogicalName siteid
RequiredLevel None
Targets site
Type Lookup

Skills

Property Value
Description Skills needed to operate the facility/equipment.
DisplayName Skills
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName skills
MaxLength 100
RequiredLevel None
Type String

TimeZoneCode

Property Value
Description Local time zone where the facility/equipment is located.
DisplayName Time Zone
Format TimeZone
IsValidForForm True
IsValidForRead True
LogicalName timezonecode
MaxValue 1500
MinValue -1500
RequiredLevel SystemRequired
Type Integer

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Unique identifier of the currency associated with the equipment.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

BusinessUnitIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName businessunitidname
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedBy

Property Value
Description Unique identifier of the user who created the facility/equipment entry.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the equipment.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the equipment with respect to the base currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the facility/equipment.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the equipment.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Property Value
Description Unique identifier of the parent business unit.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

SiteIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName siteidname
MaxLength 100
RequiredLevel SystemRequired
Type String

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

Equipment_SyncErrors

Added by: System Solution Solution

Same as syncerror entity Equipment_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Equipment_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

equipment_activity_parties

Added by: System Solution Solution

Same as activityparty entity equipment_activity_parties Many-To-One relationship.

Property Value
ReferencingEntity activityparty
ReferencingAttribute partyid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName equipment_activity_parties
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Equipment_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord entity Equipment_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Equipment_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Equipment_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord entity Equipment_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Equipment_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Equipment_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation entity Equipment_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Equipment_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder entity equipment_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName equipment_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Equipment_ProcessSessions

Added by: System Solution Solution

Same as processsession entity Equipment_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Equipment_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Equipment_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure entity Equipment_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Equipment_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_principalobjectattributeaccess

Added by: System Solution Solution

Same as principalobjectattributeaccess entity equipment_principalobjectattributeaccess Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName equipment_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_connections1

Added by: System Solution Solution

Same as connection entity equipment_connections1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName equipment_connections1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_connections2

Added by: System Solution Solution

Same as connection entity equipment_connections2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName equipment_connections2
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Equipment_Annotation

Added by: System Solution Solution

Same as annotation entity Equipment_Annotation Many-To-One relationship.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Equipment_Annotation
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Equipment_Email_EmailSender

Added by: System Solution Solution

Same as email entity Equipment_Email_EmailSender Many-To-One relationship.

Property Value
ReferencingEntity email
ReferencingAttribute emailsender
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Equipment_Email_EmailSender
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_accounts

Same as account entity equipment_accounts Many-To-One relationship.

Property Value
ReferencingEntity account
ReferencingAttribute preferredequipmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName equipment_accounts
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_contacts

Same as contact entity equipment_contacts Many-To-One relationship.

Property Value
ReferencingEntity contact
ReferencingAttribute preferredequipmentid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName equipment_contacts
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

equipment_resources

Same as resource entity equipment_resources Many-To-One relationship.

Property Value
ReferencingEntity resource
ReferencingAttribute resourceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName equipment_resources
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_equipment_createdby

Added by: System Solution Solution

See systemuser Entity lk_equipment_createdby One-To-Many relationship.

lk_equipment_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_equipment_createdonbehalfby One-To-Many relationship.

lk_equipment_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_equipment_modifiedby One-To-Many relationship.

lk_equipment_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_equipment_modifiedonbehalfby One-To-Many relationship.

business_unit_equipment

Added by: System Solution Solution

See businessunit Entity business_unit_equipment One-To-Many relationship.

calendar_equipment

Added by: System Solution Solution

See calendar Entity calendar_equipment One-To-Many relationship.

organization_equipment

Added by: System Solution Solution

See organization Entity organization_equipment One-To-Many relationship.

equipment_systemuser

Added by: System Solution Solution

See systemuser Entity equipment_systemuser One-To-Many relationship.

TransactionCurrency_Equipment

Added by: System Solution Solution

See transactioncurrency Entity TransactionCurrency_Equipment One-To-Many relationship.

site_equipment

See site Entity site_equipment One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
equipment EntityType