connection EntityType
Relationship between two entities.
- Entity Set Path
- [organization URI]/api/data/v9.2/connections
- Base Type
- crmbaseentity
- Display Name
- Connection
- Primary Key
- connectionid
- Primary Key Attribute
- name
- Operations Supported
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity.Some properties are read-only.
| Name | Type | Details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| connectionid | Edm.Guid |
Unique identifier of the connection. Display Name: Connection |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display Name: Created On Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description | Edm.String |
Type additional information to describe the connection, such as the length or quality of the relationship. Display Name: Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectiveend | Edm.DateTimeOffset |
Enter the end date of the connection. Display Name: Ending |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| effectivestart | Edm.DateTimeOffset |
Enter the start date of the connection. Display Name: Starting |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| entityimage | Edm.Binary |
The default image for the entity. Display Name: Entity Image |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| entityimage_timestamp | Edm.Int64 |
Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| entityimage_url | Edm.String |
Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| entityimageid | Edm.Guid |
For internal use only. Display Name: Entity Image Id Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| exchangerate | Edm.Decimal |
Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency. Display Name: Exchange Rate Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ismaster | Edm.Boolean |
Indicates that this is the master record. Display Name: Is Master Read Only
Default Options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display Name: Modified On Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | Edm.String |
Name of the connection. Display Name: Connection Name Read Only
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display Name: Record Created On |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| record1objecttypecode | Edm.Int32 |
Shows the record type of the source record. Display Name: Type (From) Read Only
Default Options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| record2objecttypecode | Edm.Int32 |
Shows the record type of the target record. Display Name: Type (To) Read Only
Default Options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statecode | Edm.Int32 |
Shows whether the connection is active or inactive. Inactive connections are read-only and can't be edited unless they are reactivated. Display Name: Status
Default Options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the connection. Display Name: Status Reason
Default Options
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| versionnumber | Edm.Int64 |
Version number of the connection. 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 |
Shows who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Shows who created the record on behalf of another user. |
| _modifiedby_value | modifiedby |
Shows who last updated the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Shows who last updated the record on behalf of another user. |
| _ownerid_value | ownerid |
Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
| _owningbusinessunit_value | owningbusinessunit |
Shows the business unit that the record owner belongs to. |
| _record1id_value | record1id_account record1id_activitypointer record1id_adx_invitation record1id_contact record1id_goal record1id_knowledgearticle record1id_knowledgebaserecord record1id_mspp_publishingstatetransitionrule record1id_mspp_shortcut record1id_mspp_website record1id_position record1id_processsession record1id_socialprofile record1id_systemuser record1id_team record1id_territory |
Choose the primary account, contact, or other record involved in the connection. |
| _record1roleid_value | record1roleid |
Choose the primary party's role or relationship with the second party. |
| _record2id_value | record2id_account record2id_activitypointer record2id_adx_invitation record2id_contact record2id_goal record2id_knowledgearticle record2id_knowledgebaserecord record2id_mspp_publishingstatetransitionrule record2id_mspp_shortcut record2id_mspp_website record2id_position record2id_processsession record2id_socialprofile record2id_systemuser record2id_team record2id_territory |
Select the secondary account, contact, or other record involved in the connection. |
| _record2roleid_value | record2roleid |
Choose the secondary party's role or relationship with the primary party. |
| _relatedconnectionid_value | relatedconnectionid |
Unique identifier for the reciprocal connection record. |
| _transactioncurrencyid_value | transactioncurrencyid |
Choose the local currency for the record to make sure budgets are reported in the correct currency. |
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 | createdby_connection |
| createdonbehalfby | systemuser | lk_connectionbase_createdonbehalfby |
| modifiedby | systemuser | modifiedby_connection |
| modifiedonbehalfby | systemuser | lk_connectionbase_modifiedonbehalfby |
| ownerid | principal | owner_connections |
| owningbusinessunit | businessunit | business_unit_connections |
| record1id_account | account | account_connections1 |
| record1id_activitypointer | activitypointer | activitypointer_connections1 |
| record1id_adx_invitation | adx_invitation | adx_invitation_connections1 |
| record1id_adx_inviteredemption | adx_inviteredemption | adx_inviteredemption_connections1 |
| record1id_appointment | appointment | appointment_connections1 |
| record1id_contact | contact | contact_connections1 |
| record1id_email | email_connections1 | |
| record1id_fax | fax | fax_connections1 |
| record1id_goal | goal | goal_connections1 |
| record1id_knowledgearticle | knowledgearticle | knowledgearticle_connections1 |
| record1id_knowledgebaserecord | knowledgebaserecord | KnowledgeBaseRecord_connections1 |
| record1id_letter | letter | letter_connections1 |
| record1id_mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule_connections1 |
| record1id_mspp_shortcut | mspp_shortcut | mspp_shortcut_connections1 |
| record1id_mspp_website | mspp_website | mspp_website_connections1 |
| record1id_phonecall | phonecall | phonecall_connections1 |
| record1id_position | position | position_connection1 |
| record1id_processsession | processsession | processsession_connections1 |
| record1id_recurringappointmentmaster | recurringappointmentmaster | recurringappointmentmaster_connections1 |
| record1id_socialactivity | socialactivity | socialactivity_connections1 |
| record1id_socialprofile | socialprofile | socialprofile_connections1 |
| record1id_systemuser | systemuser | systemuser_connections1 |
| record1id_task | task | task_connections1 |
| record1id_team | team | team_connections1 |
| record1id_territory | territory | territory_connections1 |
| record1roleid | connectionrole | connection_role_connections1 |
| record2id_account | account | account_connections2 |
| record2id_activitypointer | activitypointer | activitypointer_connections2 |
| record2id_adx_invitation | adx_invitation | adx_invitation_connections2 |
| record2id_adx_inviteredemption | adx_inviteredemption | adx_inviteredemption_connections2 |
| record2id_appointment | appointment | appointment_connections2 |
| record2id_contact | contact | contact_connections2 |
| record2id_email | email_connections2 | |
| record2id_fax | fax | fax_connections2 |
| record2id_goal | goal | goal_connections2 |
| record2id_knowledgearticle | knowledgearticle | knowledgearticle_connections2 |
| record2id_knowledgebaserecord | knowledgebaserecord | KnowledgeBaseRecord_connections2 |
| record2id_letter | letter | letter_connections2 |
| record2id_mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule | mspp_publishingstatetransitionrule_connections2 |
| record2id_mspp_shortcut | mspp_shortcut | mspp_shortcut_connections2 |
| record2id_mspp_website | mspp_website | mspp_website_connections2 |
| record2id_phonecall | phonecall | phonecall_connections2 |
| record2id_position | position | position_connection2 |
| record2id_processsession | processsession | processsession_connections2 |
| record2id_recurringappointmentmaster | recurringappointmentmaster | recurringappointmentmaster_connections2 |
| record2id_socialactivity | socialactivity | socialactivity_connections2 |
| record2id_socialprofile | socialprofile | socialprofile_connections2 |
| record2id_systemuser | systemuser | systemuser_connections2 |
| record2id_task | task | task_connections2 |
| record2id_team | team | team_connections2 |
| record2id_territory | territory | territory_connections2 |
| record2roleid | connectionrole | connection_role_connections2 |
| relatedconnectionid | connection | connection_related_connection |
| transactioncurrencyid | transactioncurrency | TransactionCurrency_Connection |
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 |
|---|---|---|
| Connection_AsyncOperations | asyncoperation | regardingobjectid_connection |
| connection_principalobjectattributeaccess | principalobjectattributeaccess | objectid_connection |
| Connection_ProcessSessions | processsession | regardingobjectid_connection |
| connection_related_connection | connection | relatedconnectionid |
| Connection_SyncErrors | syncerror | regardingobjectid_connection_syncerror |
Operations
The following operations can be used with the connection entity type.
| Name | Binding |
|---|---|
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |