ConnectionInstance table/entity reference

Note

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

Added by: Connection Instance Solution Solution

Messages

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

Properties

Property Value
CollectionSchemaName ConnectionInstances
DisplayCollectionName Connector Connections
DisplayName Connection Instance
EntitySetName connectioninstances
IsBPFEntity False
LogicalCollectionName connectioninstances
LogicalName connectioninstance
OwnershipType UserOwned
PrimaryIdAttribute connectioninstanceid
PrimaryNameAttribute connectioninternalid
SchemaName ConnectionInstance

Writable columns/attributes

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

AccountName

Property Value
Description The name for the account
DisplayName Account Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName accountname
MaxLength 400
RequiredLevel None
Type String

AllowSharing

Property Value
Description Whether or not allow sharing is enabled for the connection
DisplayName Allow Sharing
IsValidForForm True
IsValidForRead True
LogicalName allowsharing
RequiredLevel None
Type Boolean

AllowSharing Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

ConnectionInstanceDisplayName

Property Value
Description The display name of the Connection as seen by the user.
DisplayName Display Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectioninstancedisplayname
MaxLength 400
RequiredLevel ApplicationRequired
Type String

ConnectionInstanceId

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

ConnectionInstanceLogicalName

Property Value
Description Connection Instance unique name
DisplayName Connection Instance Logical Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectioninstancelogicalname
MaxLength 400
RequiredLevel SystemRequired
Type String

ConnectionInternalId

Property Value
Description The Id of the Connection in Api Hub
DisplayName Connection Internal Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectioninternalid
MaxLength 400
RequiredLevel ApplicationRequired
Type String

ConnectionMetadata

Property Value
Description The Metadata for the connection
DisplayName Connection Metadata
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionmetadata
MaxLength 500000
RequiredLevel None
Type String

ConnectionParametersConfig

Property Value
Description The connection parameters and values that will be passed on creation
DisplayName Connection Parameters Config
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionparametersconfig
MaxLength 20000
RequiredLevel None
Type Memo

ConnectionParameterSetConfig

Property Value
Description The connection parameters set and values that are mainly used in case of multiauth connections
DisplayName Connection Parameters Set Config
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionparametersetconfig
MaxLength 20000
RequiredLevel None
Type Memo

ConnectionReferenceId

Property Value
Description Unique identifier for Connection Reference associated with the Connection Instance.
DisplayName Parent Connection Reference
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectionreferenceid
RequiredLevel SystemRequired
Targets connectionreference
Type Lookup

ConnectionStatus

Property Value
Description The status of the connection in ApiHub
DisplayName Connection Status
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionstatus
MaxLength 4000
RequiredLevel None
Type String

ConnectorId

Property Value
Description The id of the corresponding connector if present in Dataverse
DisplayName Connector Id
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectorid
RequiredLevel None
Targets connector
Type Lookup

ConnectorInternalId

Property Value
Description The id of the Connector in ApiHub
DisplayName Connector Internal Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectorinternalid
MaxLength 400
RequiredLevel ApplicationRequired
Type String

CredentialId

Property Value
Description Unique identifier for the Credential used in the Connection Instance.
DisplayName Credential identifier
IsValidForForm True
IsValidForRead True
LogicalName credentialid
RequiredLevel None
Targets credential
Type Lookup

IconUri

Property Value
Description Icon for the Connection Instance
DisplayName Icon Uri
FormatName Url
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName iconuri
MaxLength 1000
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 Instance
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 Instance
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
Property Value
Description Links to test the connection
DisplayName Test Connection Links
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName testconnectionlinks
MaxLength 500000
RequiredLevel None
Type String

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

ConnectionReferenceIdName

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

connectoridName

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

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

CredentialIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName credentialidname
MaxLength 100
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.

connectioninstance_SyncErrors

Added by: System Solution Solution

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

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

connectioninstance_DuplicateMatchingRecord

Added by: System Solution Solution

Same as the connectioninstance_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.

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

connectioninstance_DuplicateBaseRecord

Added by: System Solution Solution

Same as the connectioninstance_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.

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

connectioninstance_AsyncOperations

Added by: System Solution Solution

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

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

connectioninstance_MailboxTrackingFolders

Added by: System Solution Solution

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

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

connectioninstance_ProcessSession

Added by: System Solution Solution

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

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

connectioninstance_BulkDeleteFailures

Added by: System Solution Solution

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

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

connectioninstance_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

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

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName connectioninstance_PrincipalObjectAttributeAccesses
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 table. Listed by SchemaName.

lk_connectioninstance_createdby

Added by: System Solution Solution

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

lk_connectioninstance_createdonbehalfby

Added by: System Solution Solution

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

lk_connectioninstance_modifiedby

Added by: System Solution Solution

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

lk_connectioninstance_modifiedonbehalfby

Added by: System Solution Solution

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

user_connectioninstance

Added by: System Solution Solution

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

team_connectioninstance

Added by: System Solution Solution

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

business_unit_connectioninstance

Added by: System Solution Solution

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

lk_connectioninstance_connectorid

Added by: Power Connector Solution Solution

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

connectionreference_connectioninstance

Added by: Power Platform Connection References Solution

See the connectionreference_connectioninstance one-to-many relationship for the connectionreference table/entity.

connectioninstance_CredentialId_credential

Added by: Power Automate Core Components Solution

See the connectioninstance_CredentialId_credential one-to-many relationship for the credential table/entity.

See also

Dataverse table/entity reference
Web API Reference
connectioninstance EntityType