ConnectionRole Entity Reference

Role describing a relationship between a two records.

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/connectionroles
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/connectionroles(connectionroleid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/connectionroles(connectionroleid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/connectionroles
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/connectionroles(connectionroleid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/connectionroles(connectionroleid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName ConnectionRoles
DisplayCollectionName Connection Roles
DisplayName Connection Role
EntitySetName connectionroles
IsBPFEntity False
LogicalCollectionName connectionroles
LogicalName connectionrole
OwnershipType OrganizationOwned
PrimaryIdAttribute connectionroleid
PrimaryNameAttribute name
SchemaName ConnectionRole

Writable attributes

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

Category

Property Value
Description Categories for connection roles.
DisplayName Connection Role Category
IsValidForForm True
IsValidForRead True
LogicalName category
RequiredLevel None
Type Picklist

Category Options

Value Label
1 Business
2 Family
3 Social
4 Sales
5 Other
1000 Stakeholder
1001 Sales Team
1002 Service

ConnectionRoleId

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

Description

Property Value
Description Description of the connection role.
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 1000
RequiredLevel None
Type String

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

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 48
RequiredLevel None
Type String

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

Name

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

StateCode

Property Value
Description Status of the connection role.
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 role.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1

Read-only attributes

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

ComponentState

Property Value
Description State of the component.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

ComponentState Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

ConnectionRoleIdUnique

Property Value
Description Unique identifier of the published or unpublished connection role record.
DisplayName Unique ID
IsValidForForm False
IsValidForRead True
LogicalName connectionroleidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

CreatedBy

Property Value
Description Unique identifier of the user who created the relationship role.
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 relationship role.
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 relationship role.
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 connection role was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the relationship role.
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

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName State
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean

IsManaged Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the connection role.
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 relationship role.
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 relationship role.
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 connection role was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the relationship role.
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 organization that this connection role belongs to.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description Name of the organization that this relationship role belongs to.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was last overwritten.
DisplayName Overwritten On
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Version number of the connection role.
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_role_connections1

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

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

ConnectionRole_SyncErrors

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

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

ConnectionRole_ProcessSessions

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

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

Connection_Role_AsyncOperations

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

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

connection_role_connections2

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

Property Value
ReferencingEntity connection
ReferencingAttribute record2roleid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName connection_role_connections2
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
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.

createdby_connection_role

See systemuser Entity createdby_connection_role One-To-Many relationship.

organization_connection_roles

See organization Entity organization_connection_roles One-To-Many relationship.

lk_connectionrolebase_createdonbehalfby

See systemuser Entity lk_connectionrolebase_createdonbehalfby One-To-Many relationship.

modifiedby_connection_role

See systemuser Entity modifiedby_connection_role One-To-Many relationship.

lk_connectionrolebase_modifiedonbehalfby

See systemuser Entity lk_connectionrolebase_modifiedonbehalfby One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the ConnectionRole entity is the first entity in the relationship. Listed by SchemaName.

connectionroleassociation_association

IntersectEntityName: connectionroleassociation

Entity 1

Property Value
IntersectAttribute connectionroleid
IsCustomizable False
LogicalName connectionrole
NavigationPropertyName connectionroleassociation_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName connectionrole
IntersectAttribute associatedconnectionroleid
NavigationPropertyName connectionroleassociation_association
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

See also

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