connectionreference table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Added by: Power Platform Connection References Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /connectionreferences(connectionreferenceid)
Update ownerid property.
AssignRequest
Create POST /connectionreferences
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /connectionreferences(connectionreferenceid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess GrantAccessRequest
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess ModifyAccess ModifyAccessRequest
PvaShareConnection PvaShareConnection Type generated by Power Platform CLI pac modelbuilder build command or use OrganizationRequest setting the required parameters for the message.
Retrieve GET /connectionreferences(connectionreferenceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /connectionreferences
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
SetState PATCH /connectionreferences(connectionreferenceid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /connectionreferences(connectionreferenceid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest

Properties

Property Value
CollectionSchemaName connectionreferences
DisplayCollectionName Connection References
DisplayName Connection Reference
EntitySetName connectionreferences
IsBPFEntity False
LogicalCollectionName connectionreferences
LogicalName connectionreference
OwnershipType UserOwned
PrimaryIdAttribute connectionreferenceid
PrimaryNameAttribute connectionreferencedisplayname
SchemaName connectionreference

Writable columns/attributes

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

ConnectionId

Property Value
Description Id of the connection in API hub
DisplayName Connection Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionid
MaxLength 1000
RequiredLevel None
Type String

connectionreferencedisplayname

Property Value
Description Display name of the connection reference
DisplayName Connection Reference Display Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionreferencedisplayname
MaxLength 200
RequiredLevel ApplicationRequired
Type String

connectionreferenceId

Property Value
Description Unique identifier for entity instances
DisplayName Connection Reference
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName connectionreferenceid
RequiredLevel SystemRequired
Type Uniqueidentifier

ConnectionReferenceLogicalName

Property Value
Description Connection Reference unique name
DisplayName Connection Reference Logical Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectionreferencelogicalname
MaxLength 200
RequiredLevel SystemRequired
Type String

ConnectorId

Property Value
Description Id of the Public/Shared Connector
DisplayName Connector Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectorid
MaxLength 1000
RequiredLevel ApplicationRequired
Type String

CustomConnectorId

Property Value
Description Look up to the Connector entity
DisplayName Custom Connector Id
IsValidForForm True
IsValidForRead True
LogicalName customconnectorid
RequiredLevel None
Targets connector
Type Lookup

Description

Property Value
Description Description of Connection Reference
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type String

ImportSequenceNumber

Added by: Basic Solution Solution

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

IsCustomizable

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

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

Added by: Active Solution Solution

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

statecode

Property Value
Description Status of the Connection Reference
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

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

statuscode

Property Value
Description Reason for the status of the Connection Reference
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

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

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 columns/attributes

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

ComponentIdUnique

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Added by: Basic Solution Solution

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist

ComponentState Choices/Options

Value Label Description
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Added by: Active Solution Solution

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

CreatedByName

Added by: Active Solution Solution

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

CreatedByYomiName

Added by: Active Solution Solution

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

CreatedOn

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

CreatedOnBehalfBy

Added by: Active Solution Solution

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

CreatedOnBehalfByName

Added by: Active Solution Solution

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

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

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

CustomConnectorIdName

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

IsManaged

Added by: Basic Solution Solution

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

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: 0

ModifiedBy

Added by: Active Solution Solution

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

ModifiedByName

Added by: Active Solution Solution

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

ModifiedByYomiName

Added by: Active Solution Solution

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

ModifiedOn

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

ModifiedOnBehalfBy

Added by: Active Solution Solution

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

ModifiedOnBehalfByName

Added by: Active Solution Solution

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

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

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

OverwriteTime

Added by: Basic Solution Solution

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

OwnerIdName

Added by: Active Solution Solution

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

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

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

OwningTeam

Added by: Active Solution Solution

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Added by: Active Solution Solution

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

SolutionId

Added by: Basic Solution Solution

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

SupportingSolutionId

Added by: Basic Solution Solution

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

VersionNumber

Added by: Active Solution Solution

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.

connectionreference_SyncErrors

Added by: System Solution Solution

Same as the connectionreference_SyncErrors many-to-one relationship for the syncerror table/entity.

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

connectionreference_AsyncOperations

Added by: System Solution Solution

Same as the connectionreference_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

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

connectionreference_MailboxTrackingFolders

Added by: System Solution Solution

Same as the connectionreference_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

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

connectionreference_ProcessSession

Added by: System Solution Solution

Same as the connectionreference_ProcessSession many-to-one relationship for the processsession table/entity.

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

connectionreference_BulkDeleteFailures

Added by: System Solution Solution

Same as the connectionreference_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

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

connectionreference_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the connectionreference_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

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

connectionreference_connectioninstance

Added by: Connection Instance Solution Solution

Same as the connectionreference_connectioninstance many-to-one relationship for the connectioninstance table/entity.

Property Value
ReferencingEntity connectioninstance
ReferencingAttribute connectionreferenceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName connectionreference_connectioninstance
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

bot_connectionreference

Added by: Power Virtual Agents Solution

Same as the bot_connectionreference many-to-one relationship for the bot table/entity.

Property Value
ReferencingEntity bot
ReferencingAttribute providerconnectionreferenceid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName bot_connectionreference
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_dfcr_cr_connect

Added by: Insights App Platform Base Solution

Same as the msdyn_dfcr_cr_connect many-to-one relationship for the msdyn_dataflowconnectionreference table/entity.

Property Value
ReferencingEntity msdyn_dataflowconnectionreference
ReferencingAttribute msdyn_connectionreference
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_msdyn_dataflowconnectionreference_Connect
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_connreference_msdyn_connectordatasource

Added by: Virtual Connector Provider Solution

Same as the msdyn_connreference_msdyn_connectordatasource many-to-one relationship for the msdyn_connectordatasource table/entity.

Property Value
ReferencingEntity msdyn_connectordatasource
ReferencingAttribute msdyn_connectionreferenceid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_connreference_msdyn_connectordatasource
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_AIConfiguration_ConnectionReference

Added by: AISolution Solution

Same as the msdyn_AIConfiguration_ConnectionReference many-to-one relationship for the msdyn_aiconfiguration table/entity.

Property Value
ReferencingEntity msdyn_aiconfiguration
ReferencingAttribute msdyn_connectionreferenceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName msdyn_AIConfiguration_ConnectionReference
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
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 table. Listed by SchemaName.

lk_connectionreference_createdby

Added by: System Solution Solution

See the lk_connectionreference_createdby one-to-many relationship for the systemuser table/entity.

lk_connectionreference_createdonbehalfby

Added by: System Solution Solution

See the lk_connectionreference_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_connectionreference_modifiedby

Added by: System Solution Solution

See the lk_connectionreference_modifiedby one-to-many relationship for the systemuser table/entity.

lk_connectionreference_modifiedonbehalfby

Added by: System Solution Solution

See the lk_connectionreference_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

user_connectionreference

Added by: System Solution Solution

See the user_connectionreference one-to-many relationship for the systemuser table/entity.

team_connectionreference

Added by: System Solution Solution

See the team_connectionreference one-to-many relationship for the team table/entity.

business_unit_connectionreference

Added by: System Solution Solution

See the business_unit_connectionreference one-to-many relationship for the businessunit table/entity.

connector_connectionreference

Added by: Power Connector Solution Solution

See the connector_connectionreference one-to-many relationship for the connector table/entity.

Many-To-Many Relationships

Relationship details provided where the connectionreference table is the first table in the relationship. Listed by SchemaName.

botcomponent_connectionreference

See the botcomponent_connectionreference many-to-many relationship for the botcomponent table/entity.

See also

Dataverse table/entity reference
Web API Reference
connectionreference EntityType