connectioninstance EntityType
- Entity Set Path
- [organization URI]/api/data/v9.2/connectioninstances
- Base Type
- crmbaseentity
- Display Name
- Connection Instance
- Primary Key
- connectioninstanceid
- Primary Key Attribute
- connectioninternalid
- Operations Supported
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity.Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accountname | Edm.String |
The name for the account Display Name: Account Name |
||||||||||
| allowsharing | Edm.Boolean |
Whether or not allow sharing is enabled for the connection Display Name: Allow Sharing
Default Options
|
||||||||||
| 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
|
||||||||||
| connectioninstancedisplayname | Edm.String |
The display name of the Connection as seen by the user. Display Name: Display Name |
||||||||||
| connectioninstanceid | Edm.Guid |
Unique identifier for entity instances Display Name: Connection Instance |
||||||||||
| connectioninstancelogicalname | Edm.String |
Connection Instance unique name Display Name: Connection Instance Logical Name |
||||||||||
| connectioninternalid | Edm.String |
The Id of the Connection in Api Hub Display Name: Connection Internal Id |
||||||||||
| connectionmetadata | Edm.String |
The Metadata for the connection Display Name: Connection Metadata |
||||||||||
| connectionparametersconfig | Edm.String |
The connection parameters and values that will be passed on creation Display Name: Connection Parameters Config |
||||||||||
| connectionparametersetconfig | Edm.String |
The connection parameters set and values that are mainly used in case of multiauth connections Display Name: Connection Parameters Set Config |
||||||||||
| connectionstatus | Edm.String |
The status of the connection in ApiHub Display Name: Connection Status |
||||||||||
| connectorinternalid | Edm.String |
The id of the Connector in ApiHub Display Name: Connector Internal Id |
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||
| iconuri | Edm.String |
Icon for the Connection Instance Display Name: Icon Uri |
||||||||||
| 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
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Connection Instance Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Connection Instance Display Name: Status Reason
Default Options
|
||||||||||
| testconnectionlinks | Edm.String |
Links to test the connection Display Name: Test Connection Links |
||||||||||
| 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 |
|---|---|---|
| _connectionreferenceid_value | connectionreferenceId |
Unique identifier for Connection Reference associated with the Connection Instance. |
| _connectorid_value | connectorid |
The id of the corresponding connector if present in Dataverse |
| _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. |
| _credentialid_value | CredentialId |
Unique identifier for the Credential used in the Connection Instance. |
| _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 |
|---|---|---|
| connectionreferenceId | connectionreference | connectionreference_connectioninstance |
| connectorid | connector | ConnectionInstance_connectorid_con |
| createdby | systemuser | lk_connectioninstance_createdby |
| createdonbehalfby | systemuser | lk_connectioninstance_createdonbehalfby |
| CredentialId | credential | connectioninstance_CredentialId_credential |
| modifiedby | systemuser | lk_connectioninstance_modifiedby |
| modifiedonbehalfby | systemuser | lk_connectioninstance_modifiedonbehalfby |
| ownerid | principal | owner_connectioninstance |
| owningbusinessunit | businessunit | business_unit_connectioninstance |
| owningteam | team | team_connectioninstance |
| owninguser | systemuser | user_connectioninstance |
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 |
|---|---|---|
| connectioninstance_AsyncOperations | asyncoperation | regardingobjectid_connectioninstance |
| connectioninstance_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_connectioninstance |
| connectioninstance_DuplicateBaseRecord | duplicaterecord | baserecordid_connectioninstance |
| connectioninstance_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_connectioninstance |
| connectioninstance_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_connectioninstance |
| connectioninstance_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_connectioninstance |
| connectioninstance_ProcessSession | processsession | regardingobjectid_connectioninstance |
| connectioninstance_SyncErrors | syncerror | regardingobjectid_connectioninstance |
Operations
The following operations can be used with the connectioninstance entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |