connectionreference EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/connectionreferences
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Connection Reference
- Primary key:
- connectionreferenceid
- Primary name column:
- connectionreferencedisplayname
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| componentidunique | Edm.Guid |
For internal use only. Display name: Row id unique Read only
|
||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||
| connectionid | Edm.String |
Id of the connection in API hub Display name: Connection Id |
||||||||||
| connectionreferencedisplayname | Edm.String |
Display name of the connection reference Display name: Connection Reference Display Name |
||||||||||
| connectionreferenceid | Edm.Guid |
Unique identifier for entity instances Display name: Connection Reference |
||||||||||
| connectionreferencelogicalname | Edm.String |
Connection Reference unique name Display name: Connection Reference Logical Name |
||||||||||
| connectorid | Edm.String |
Id of the Public/Shared Connector Display name: Connector Id |
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||
| description | Edm.String |
Description of Connection Reference Display name: Description |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||
| iscustomizable | BooleanManagedProperty |
For internal use only. Display name: Is Customizable |
||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: Is Managed Read only
Default options
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||
| promptingbehavior | Edm.Int32 |
The Prompting Behavior for this connection reference Display name: Prompting Behavior
Default options
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Connection Reference Display name: Status
Default options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Connection Reference Display name: Status Reason
Default options
|
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _customconnectorid_value | CustomConnectorId |
Look up to the Connector entity |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_connectionreference_createdby |
| createdonbehalfby | systemuser | lk_connectionreference_createdonbehalfby |
| CustomConnectorId | connector | connector_connectionreference |
| modifiedby | systemuser | lk_connectionreference_modifiedby |
| modifiedonbehalfby | systemuser | lk_connectionreference_modifiedonbehalfby |
| ownerid | principal | owner_connectionreference |
| owningbusinessunit | businessunit | business_unit_connectionreference |
| owningteam | team | team_connectionreference |
| owninguser | systemuser | user_connectionreference |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| bot_connectionreference | bot | ProviderConnectionReferenceId |
| botcomponent_connectionreference | botcomponent | botcomponent_connectionreference |
| connectionreference_AsyncOperations | asyncoperation | regardingobjectid_connectionreference |
| connectionreference_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_connectionreference |
| connectionreference_connectioninstance | connectioninstance | connectionreferenceId |
| ConnectionReference_DVTableSearch | dvtablesearch | ConnectionReference |
| connectionreference_federatedknowledgeconfiguration | federatedknowledgeconfiguration | ConnectionReference |
| connectionreference_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_connectionreference |
| connectionreference_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_connectionreference |
| connectionreference_ProcessSession | processsession | regardingobjectid_connectionreference |
| connectionreference_SyncErrors | syncerror | regardingobjectid_connectionreference |
| msdyn_AIConfiguration_ConnectionReference | msdyn_aiconfiguration | msdyn_ConnectionReferenceId |
| msdyn_connreference_msdyn_connectordatasource | msdyn_connectordatasource | msdyn_ConnectionReferenceId |
| msdyn_msdyn_dataflowconnectionreference_Connect | msdyn_dataflowconnectionreference | msdyn_ConnectionReference |
Operations
The following operations can be used with the connectionreference entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| PvaShareConnection | Bound to Entity |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |