connection EntityType

Relationship between two entities.

Entity Set Path
[organization URI]/api/data/v9.0/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
Value Label
1 Yes
0 No
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
Value Label
4201 Appointment
4207 Letter
4710 Process Session
50 Position
4200 Activity
99 Social Profile
4212 Task
2 Contact
4216 Social Activity
4251 Recurring Appointment
4204 Fax
8 User
9930 Knowledge Base Record
4202 Email
4210 Phone Call
9600 Goal
1 Account
9953 Knowledge Article
2013 Territory
9400 Channel Access Profile Rule
9 Team
record2objecttypecode Edm.Int32

Shows the record type of the target record.

Display Name: Type (To)

Read Only
Default Options
Value Label
4210 Phone Call
4710 Process Session
2 Contact
4201 Appointment
4212 Task
9400 Channel Access Profile Rule
1 Account
50 Position
2013 Territory
9 Team
8 User
9600 Goal
9953 Knowledge Article
4251 Recurring Appointment
4200 Activity
4207 Letter
4216 Social Activity
4204 Fax
4202 Email
99 Social Profile
9930 Knowledge Base Record
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
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the connection.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
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 Retrieve data about lookup properties.

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.

_owningteam_value createdby

Unique identifier of the team who owns the connection.

_owninguser_value createdby

Unique identifier of the user who owns the connection.

_record1id_value record1id_knowledgearticlerecord1id_knowledgebaserecordrecord1id_contactrecord1id_systemuserrecord1id_socialprofilerecord1id_teamrecord1id_positionrecord1id_processsessionrecord1id_goalrecord1id_accountrecord1id_activitypointerrecord1id_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_knowledgearticlerecord2id_knowledgebaserecordrecord2id_accountrecord2id_systemuserrecord2id_teamrecord2id_socialprofilerecord2id_goalrecord2id_positionrecord2id_processsessionrecord2id_activitypointerrecord2id_contactrecord2id_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_appointment appointment appointment_connections1
record1id_contact contact contact_connections1
record1id_email 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_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_appointment appointment appointment_connections2
record2id_contact contact contact_connections2
record2id_email 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_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

Solutions

The following solutions include the connection entity type.

Name Description
System Solution Internal CRM System Solution
Second Patch for Application Common For internal use only.
Knowledge Management Dynamics 365 workload for knowledge management.
Application Common For internal use only.
Application Common Patch For internal use only.
Knowledge Management Patch Dynamics 365 workload for knowledge management.

See also