Connection Entity Reference

Relationship between two entities.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/connections(connectionid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/connections
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/connections(connectionid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/connections(connectionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/connections
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/connections(connectionid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/connections(connectionid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Connections
DisplayCollectionName Connections
DisplayName Connection
EntitySetName connections
IsBPFEntity False
LogicalCollectionName connections
LogicalName connection
OwnershipType UserOwned
PrimaryIdAttribute connectionid
PrimaryNameAttribute name
SchemaName Connection

Writable attributes

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

ConnectionId

Property Value
Description Unique identifier of the connection.
DisplayName Connection
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName connectionid
RequiredLevel SystemRequired
Type Uniqueidentifier

Description

Property Value
Description Type additional information to describe the connection, such as the length or quality of the relationship.
DisplayName Description
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EffectiveEnd

Property Value
DateTimeBehavior UserLocal
Description Enter the end date of the connection.
DisplayName Ending
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName effectiveend
RequiredLevel None
Type DateTime

EffectiveStart

Property Value
DateTimeBehavior UserLocal
Description Enter the start date of the connection.
DisplayName Starting
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName effectivestart
RequiredLevel None
Type DateTime

EntityImage

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage False
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration 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

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

OwnerId

Property Value
Description Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description Type of the owner of the connection, such as user, team, or business unit.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

Record1Id

Property Value
Description Choose the primary account, contact, or other record involved in the connection.
DisplayName Connected From
IsValidForForm True
IsValidForRead True
LogicalName record1id
RequiredLevel None
Targets account,activitypointer,appointment,channelaccessprofilerule,contact,email,fax,goal,knowledgearticle,knowledgebaserecord,letter,phonecall,position,processsession,recurringappointmentmaster,socialactivity,socialprofile,systemuser,task,team,territory
Type Lookup

Record1IdObjectTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName record1idobjecttypecode
RequiredLevel None
Type EntityName

Record1RoleId

Property Value
Description Choose the primary party's role or relationship with the second party.
DisplayName Role (From)
IsValidForForm True
IsValidForRead True
LogicalName record1roleid
RequiredLevel None
Targets connectionrole
Type Lookup

Record2Id

Property Value
Description Select the secondary account, contact, or other record involved in the connection.
DisplayName Connected To
IsValidForForm True
IsValidForRead True
LogicalName record2id
RequiredLevel None
Targets account,activitypointer,appointment,channelaccessprofilerule,contact,email,fax,goal,knowledgearticle,knowledgebaserecord,letter,phonecall,position,processsession,recurringappointmentmaster,socialactivity,socialprofile,systemuser,task,team,territory
Type Lookup

Record2IdObjectTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName record2idobjecttypecode
RequiredLevel None
Type EntityName

Record2RoleId

Property Value
Description Choose the secondary party's role or relationship with the primary party.
DisplayName Role (To)
IsValidForForm True
IsValidForRead True
LogicalName record2roleid
RequiredLevel None
Targets connectionrole
Type Lookup

StateCode

Property Value
Description Shows whether the connection is active or inactive. Inactive connections are read-only and can't be edited unless they are reactivated.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Reason for the status of the connection.
DisplayName Status Reason
IsValidForForm False
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

Read-only attributes

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

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description Name of the user who created the connection.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description YomiName of the user who created the connection.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
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

EntityImage_Timestamp

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

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description For internal use only.
DisplayName Entity Image Id
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeRate

Property Value
Description Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

IsMaster

Property Value
Description Indicates that this is the master record.
DisplayName Is Master
IsValidForForm False
IsValidForRead True
LogicalName ismaster
RequiredLevel SystemRequired
Type Boolean

IsMaster Options

Value Label
1 Yes
0 No

DefaultValue: False

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description Name of the user who last modified the connection.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description YomiName of the user who last modified the connection.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
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

Name

Property Value
Description Name of the connection.
DisplayName Connection Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName name
MaxLength 500
RequiredLevel ApplicationRequired
Type String

OwnerIdName

Property Value
Description Name of the owner of the connection.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

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

OwningBusinessUnit

Property Value
Description Shows the business unit that the record owner belongs to.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier of the team who owns the connection.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the connection.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

Record1IdName

Property Value
Description Display name for the source record.
DisplayName Name (From)
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName record1idname
MaxLength 500
RequiredLevel None
Type String

Record1ObjectTypeCode

Property Value
Description Shows the record type of the source record.
DisplayName Type (From)
IsValidForForm True
IsValidForRead True
LogicalName record1objecttypecode
RequiredLevel None
Type Picklist

Record1ObjectTypeCode Options

Value Label
1 Account
2 Contact
8 User
9 Team
50 Position
99 Social Profile
2013 Territory
4200 Activity
4201 Appointment
4202 Email
4204 Fax
4207 Letter
4210 Phone Call
4212 Task
4216 Social Activity
4251 Recurring Appointment
4710 Process Session
9400 Channel Access Profile Rule
9600 Goal
9930 Knowledge Base Record
9953 Knowledge Article

Record1RoleIdName

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

Record2IdName

Property Value
Description Display name for the target record.
DisplayName Name (To)
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName record2idname
MaxLength 500
RequiredLevel None
Type String

Record2ObjectTypeCode

Property Value
Description Shows the record type of the target record.
DisplayName Type (To)
IsValidForForm True
IsValidForRead True
LogicalName record2objecttypecode
RequiredLevel None
Type Picklist

Record2ObjectTypeCode Options

Value Label
1 Account
2 Contact
8 User
9 Team
50 Position
99 Social Profile
2013 Territory
4200 Activity
4201 Appointment
4202 Email
4204 Fax
4207 Letter
4210 Phone Call
4212 Task
4216 Social Activity
4251 Recurring Appointment
4710 Process Session
9400 Channel Access Profile Rule
9600 Goal
9930 Knowledge Base Record
9953 Knowledge Article

Record2RoleIdName

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

RelatedConnectionId

Property Value
Description Unique identifier for the reciprocal connection record.
DisplayName Reciprocal Connection
IsValidForForm False
IsValidForRead True
LogicalName relatedconnectionid
RequiredLevel ApplicationRequired
Targets connection
Type Lookup

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 of the connection.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

Connection_AsyncOperations

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

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

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

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

connection_principalobjectattributeaccess

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

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

Connection_SyncErrors

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

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

Connection_ProcessSessions

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

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Connection_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
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.

territory_connections1

Added by: Application Common Solution

See territory Entity territory_connections1 One-To-Many relationship.

territory_connections2

Added by: Application Common Solution

See territory Entity territory_connections2 One-To-Many relationship.

knowledgearticle_connections1

See knowledgearticle Entity knowledgearticle_connections1 One-To-Many relationship.

knowledgearticle_connections2

See knowledgearticle Entity knowledgearticle_connections2 One-To-Many relationship.

KnowledgeBaseRecord_connections1

See knowledgebaserecord Entity KnowledgeBaseRecord_connections1 One-To-Many relationship.

KnowledgeBaseRecord_connections2

See knowledgebaserecord Entity KnowledgeBaseRecord_connections2 One-To-Many relationship.

processsession_connections1

See processsession Entity processsession_connections1 One-To-Many relationship.

contact_connections1

See contact Entity contact_connections1 One-To-Many relationship.

recurringappointmentmaster_connections1

See recurringappointmentmaster Entity recurringappointmentmaster_connections1 One-To-Many relationship.

processsession_connections2

See processsession Entity processsession_connections2 One-To-Many relationship.

letter_connections1

See letter Entity letter_connections1 One-To-Many relationship.

connection_role_connections2

See connectionrole Entity connection_role_connections2 One-To-Many relationship.

systemuser_connections2

See systemuser Entity systemuser_connections2 One-To-Many relationship.

letter_connections2

See letter Entity letter_connections2 One-To-Many relationship.

appointment_connections1

See appointment Entity appointment_connections1 One-To-Many relationship.

email_connections1

See email Entity email_connections1 One-To-Many relationship.

account_connections1

See account Entity account_connections1 One-To-Many relationship.

fax_connections2

See fax Entity fax_connections2 One-To-Many relationship.

activitypointer_connections2

See activitypointer Entity activitypointer_connections2 One-To-Many relationship.

socialprofile_connections2

See socialprofile Entity socialprofile_connections2 One-To-Many relationship.

createdby_connection

See systemuser Entity createdby_connection One-To-Many relationship.

account_connections2

See account Entity account_connections2 One-To-Many relationship.

phonecall_connections1

See phonecall Entity phonecall_connections1 One-To-Many relationship.

task_connections1

See task Entity task_connections1 One-To-Many relationship.

modifiedby_connection

See systemuser Entity modifiedby_connection One-To-Many relationship.

appointment_connections2

See appointment Entity appointment_connections2 One-To-Many relationship.

phonecall_connections2

See phonecall Entity phonecall_connections2 One-To-Many relationship.

TransactionCurrency_Connection

See transactioncurrency Entity TransactionCurrency_Connection One-To-Many relationship.

task_connections2

See task Entity task_connections2 One-To-Many relationship.

fax_connections1

See fax Entity fax_connections1 One-To-Many relationship.

position_connection2

See position Entity position_connection2 One-To-Many relationship.

goal_connections1

See goal Entity goal_connections1 One-To-Many relationship.

connection_role_connections1

See connectionrole Entity connection_role_connections1 One-To-Many relationship.

position_connection1

See position Entity position_connection1 One-To-Many relationship.

email_connections2

See email Entity email_connections2 One-To-Many relationship.

team_connections1

See team Entity team_connections1 One-To-Many relationship.

lk_connectionbase_modifiedonbehalfby

See systemuser Entity lk_connectionbase_modifiedonbehalfby One-To-Many relationship.

socialactivity_connections1

See socialactivity Entity socialactivity_connections1 One-To-Many relationship.

See connection Entity connection_related_connection One-To-Many relationship.

contact_connections2

See contact Entity contact_connections2 One-To-Many relationship.

lk_connectionbase_createdonbehalfby

See systemuser Entity lk_connectionbase_createdonbehalfby One-To-Many relationship.

activitypointer_connections1

See activitypointer Entity activitypointer_connections1 One-To-Many relationship.

systemuser_connections1

See systemuser Entity systemuser_connections1 One-To-Many relationship.

team_connections2

See team Entity team_connections2 One-To-Many relationship.

business_unit_connections

See businessunit Entity business_unit_connections One-To-Many relationship.

goal_connections2

See goal Entity goal_connections2 One-To-Many relationship.

socialprofile_connections1

See socialprofile Entity socialprofile_connections1 One-To-Many relationship.

socialactivity_connections2

See socialactivity Entity socialactivity_connections2 One-To-Many relationship.

recurringappointmentmaster_connections2

See recurringappointmentmaster Entity recurringappointmentmaster_connections2 One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
connection EntityType