connector entity reference

Note

Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.

Connector Entity to support Solutioning Integration

Added by: Power Connector Solution Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/connectors(connectorid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/connectors
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/connectors(connectorid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/connectors(connectorid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/connectors
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/connectors(connectorid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/connectors(connectorid)
See Update
UpdateRequest or
Update

Entity properties

Property Value
CollectionSchemaName connectors
DisplayCollectionName Connectors
DisplayName Connector
EntitySetName connectors
IsBPFEntity False
LogicalCollectionName connectors
LogicalName connector
OwnershipType UserOwned
PrimaryIdAttribute connectorid
PrimaryNameAttribute name
SchemaName connector

Writable attributes

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

ConnectionParameters

Property Value
Description Connection parameters of the Connector
DisplayName ConnectionParameters
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionparameters
MaxLength 500000
RequiredLevel None
Type String

connectorId

Property Value
Description Unique identifier for entity instances
DisplayName Connector
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName connectorid
RequiredLevel SystemRequired
Type Uniqueidentifier

ConnectorInternalId

Property Value
Description Internal Connector Id
DisplayName Internal Connector Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName connectorinternalid
MaxLength 400
RequiredLevel None
Type String

ConnectorType

Property Value
Description Connector Type
DisplayName Connector Type
IsValidForForm True
IsValidForRead True
LogicalName connectortype
RequiredLevel ApplicationRequired
Type Picklist

ConnectorType Options

Value Label
0 NotSpecified
1 CustomConnector

Description

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

DisplayName

Property Value
Description Display Name of the Connector
DisplayName Display Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName displayname
MaxLength 200
RequiredLevel None
Type String

IconBlob

Added by: Active Solution Solution

Property Value
Description Icon for the Connector
DisplayName Icon Blob
IsPrimaryImage True
IsValidForForm False
IsValidForRead True
LogicalName iconblob
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

IconBrandColor

Property Value
Description Connector Icon Branding Color
DisplayName Icon Brand Color
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName iconbrandcolor
MaxLength 100
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

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 Tells whether the component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

Name

Property Value
Description Required logical name of the Connector
DisplayName Logical Name of the Connector
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName name
MaxLength 500
RequiredLevel ApplicationRequired
Type String

OpenApiDefinition

Property Value
Description OpenApi Definition supported by Connector
DisplayName Open Api Definition
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName openapidefinition
MaxLength 500000
RequiredLevel None
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

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

PolicyTemplateInstances

Property Value
Description Apim Policy Template Instances
DisplayName PolicyTemplateInstances
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName policytemplateinstances
MaxLength 500000
RequiredLevel None
Type String

statecode

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

statuscode 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 attributes

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

ComponentState

Property Value
Description For internal use only.
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

ConnectorIdUnique

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName connectoridunique
RequiredLevel SystemRequired
Type Uniqueidentifier

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

IconBlob_Timestamp

Added by: Active Solution Solution

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

IconBlob_URL

Added by: Active Solution Solution

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

IconBlobId

Added by: Active Solution Solution

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName iconblobid
RequiredLevel None
Type Uniqueidentifier

IsManaged

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 Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

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

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
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 False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

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

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

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.

connector_SyncErrors

Added by: System Solution Solution

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

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

connector_DuplicateMatchingRecord

Added by: System Solution Solution

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

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

connector_DuplicateBaseRecord

Added by: System Solution Solution

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

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

connector_AsyncOperations

Added by: System Solution Solution

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

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

connector_MailboxTrackingFolders

Added by: System Solution Solution

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

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

connector_ProcessSession

Added by: System Solution Solution

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

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

connector_BulkDeleteFailures

Added by: System Solution Solution

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

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

connector_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

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

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

connector_connectionreference

Added by: Power Platform Connection References Solution

Same as connectionreference entity connector_connectionreference Many-To-One relationship.

Property Value
ReferencingEntity connectionreference
ReferencingAttribute customconnectorid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName connector_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 entity. Listed by SchemaName.

lk_connector_createdby

Added by: System Solution Solution

See systemuser Entity lk_connector_createdby One-To-Many relationship.

lk_connector_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_connector_createdonbehalfby One-To-Many relationship.

lk_connector_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_connector_modifiedby One-To-Many relationship.

lk_connector_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_connector_modifiedonbehalfby One-To-Many relationship.

user_connector

Added by: System Solution Solution

See systemuser Entity user_connector One-To-Many relationship.

team_connector

Added by: System Solution Solution

See team Entity team_connector One-To-Many relationship.

business_unit_connector

Added by: System Solution Solution

See businessunit Entity business_unit_connector One-To-Many relationship.

See also

About entity reference
Web API reference
connector EntityType

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).