connection EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Relationship between two entities.

Entity Set path:[organization URI]/api/data/v8.2/connections

Base Type: crmbaseentity EntityType

Display Name: Connection

Primary Key: connectionid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

connectionid

Edm.Guid

Description: Unique identifier of the connection.

Display Name: Connection

createdon

Edm.DateTimeOffset

Description: 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 property

description

Edm.String

Description: Type additional information to describe the connection, such as the length or quality of the relationship.

Display Name: Description

effectiveend

Edm.DateTimeOffset

Description: Enter the end date of the connection.

Display Name: Ending

effectivestart

Edm.DateTimeOffset

Description: Enter the start date of the connection.

Display Name: Starting

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

exchangerate

Edm.Decimal

Description: 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 property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

ismaster

Edm.Boolean

Description: Indicates that this is the master record.

Default Options:

1 : Yes
0 : No

Display Name: Is Master

Read-only property

modifiedon

Edm.DateTimeOffset

Description: 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 property

name

Edm.String

Description: Name of the connection.

Display Name: Connection Name

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

record1objecttypecode

Edm.Int32

Description: Shows the record type of the source record.

Default Options:

4216 : Social Activity
4 : Lead
4202 : Email
2013 : Territory
4204 : Fax
1088 : Order
1 : Account
4300 : Marketing List
9400 : Channel Access Profile Rule
3 : Opportunity
9930 : Knowledge Base Record
4251 : Recurring Appointment
1010 : Contract
4005 : Scheduling Group
4200 : Activity
4007 : Resource Group
4400 : Campaign
9953 : Knowledge Article
123 : Competitor
4000 : Facility/Equipment
10000 : Profile Album
4402 : Campaign Activity
9600 : Goal
4207 : Letter
1024 : Product
4710 : Process Session
9 : Team
4212 : Task
50 : Position
4210 : Phone Call
112 : Case
1084 : Quote
99 : Social Profile
2 : Contact
1022 : Price List
9700 : Entitlement
1090 : Invoice
8 : User
4201 : Appointment
4214 : Service Activity

Display Name: Type (From)

Read-only property

record2objecttypecode

Edm.Int32

Description: Shows the record type of the target record.

Default Options:

4216 : Social Activity
4 : Lead
4300 : Marketing List
2013 : Territory
99 : Social Profile
1088 : Order
1 : Account
1022 : Price List
9400 : Channel Access Profile Rule
3 : Opportunity
9930 : Knowledge Base Record
4251 : Recurring Appointment
1010 : Contract
4005 : Scheduling Group
4200 : Activity
4007 : Resource Group
4400 : Campaign
9953 : Knowledge Article
123 : Competitor
4000 : Facility/Equipment
4402 : Campaign Activity
50 : Position
4202 : Email
10000 : Profile Album
9600 : Goal
4710 : Process Session
9 : Team
4204 : Fax
4210 : Phone Call
4212 : Task
4201 : Appointment
4214 : Service Activity
1084 : Quote
2 : Contact
112 : Case
4207 : Letter
1024 : Product
1090 : Invoice
8 : User
9700 : Entitlement

Display Name: Type (To)

Read-only property

statecode

Edm.Int32

Description: Shows whether the connection is active or inactive. Inactive connections are read-only and can't be edited unless they are reactivated.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Reason for the status of the connection.

Default Options:

1 : Active
2 : Inactive

Display Name: Status Reason

versionnumber

Edm.Int64

Description: Version number of the connection.

Display Name: Version Number

Read-only property

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

Unique identifier of the team who owns the connection.

_owninguser_value

Unique identifier of the user who owns the connection.

_record1id_value

record1id_knowledgearticle

record1id_entitlement

record1id_knowledgebaserecord

record1id_contact

record1id_systemuser

record1id_territory

record1id_invoice

record1id_quote

record1id_contract

record1id_resourcegroup

record1id_socialprofile

record1id_campaign

record1id_team

record1id_position

record1id_competitor

record1id_list

record1id_incident

record1id_equipment

record1id_product

record1id_opportunity

record1id_goal

record1id_account

record1id_lead

record1id_constraintbasedgroup

record1id_activitypointer

record1id_salesorder

record1id_pricelevel

Unique identifier of the source record.

_record1roleid_value

record1roleid

Choose the primary party's role or relationship with the second party.

_record2id_value

record2id_knowledgearticle

record2id_entitlement

record2id_knowledgebaserecord

record2id_lead

record2id_account

record2id_systemuser

record2id_team

record2id_territory

record2id_quote

record2id_incident

record2id_resourcegroup

record2id_contract

record2id_list

record2id_pricelevel

record2id_salesorder

record2id_competitor

record2id_socialprofile

record2id_product

record2id_goal

record2id_constraintbasedgroup

record2id_opportunity

record2id_invoice

record2id_position

record2id_activitypointer

record2id_contact

record2id_equipment

record2id_campaign

Unique identifier of the target record.

_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 EntityType

createdby_connection

createdonbehalfby

systemuser EntityType

lk_connectionbase_createdonbehalfby

modifiedby

systemuser EntityType

modifiedby_connection

modifiedonbehalfby

systemuser EntityType

lk_connectionbase_modifiedonbehalfby

ownerid

principal EntityType

owner_connections

owningbusinessunit

businessunit EntityType

business_unit_connections

record1id_account

account EntityType

account_connections1

record1id_activitypointer

activitypointer EntityType

activitypointer_connections1

record1id_appointment

appointment EntityType

appointment_connections1

record1id_campaign

campaign EntityType

campaign_connections1

record1id_campaignactivity

campaignactivity EntityType

campaignactivity_connections1

record1id_competitor

competitor EntityType

competitor_connections1

record1id_constraintbasedgroup

constraintbasedgroup EntityType

constraintbasedgroup_connections1

record1id_contact

contact EntityType

contact_connections1

record1id_contract

contract EntityType

contract_connections1

record1id_email

email EntityType

email_connections1

record1id_entitlement

entitlement EntityType

entitlement_connections1

record1id_equipment

equipment EntityType

equipment_connections1

record1id_fax

fax EntityType

fax_connections1

record1id_goal

goal EntityType

goal_connections1

record1id_incident

incident EntityType

incident_connections1

record1id_invoice

invoice EntityType

invoice_connections1

record1id_knowledgearticle

knowledgearticle EntityType

knowledgearticle_connections1

record1id_knowledgebaserecord

knowledgebaserecord EntityType

KnowledgeBaseRecord_connections1

record1id_lead

lead EntityType

lead_connections1

record1id_letter

letter EntityType

letter_connections1

record1id_list

list EntityType

list_connections1

record1id_opportunity

opportunity EntityType

opportunity_connections1

record1id_phonecall

phonecall EntityType

phonecall_connections1

record1id_position

position EntityType

position_connection1

record1id_pricelevel

pricelevel EntityType

pricelevel_connections1

record1id_product

product EntityType

product_connections1

record1id_quote

quote EntityType

quote_connections1

record1id_recurringappointmentmaster

recurringappointmentmaster EntityType

recurringappointmentmaster_connections1

record1id_resourcegroup

resourcegroup EntityType

resourcegroup_connections1

record1id_salesorder

salesorder EntityType

salesorder_connections1

record1id_serviceappointment

serviceappointment EntityType

serviceappointment_connections1

record1id_socialactivity

socialactivity EntityType

socialactivity_connections1

record1id_socialprofile

socialprofile EntityType

socialprofile_connections1

record1id_systemuser

systemuser EntityType

systemuser_connections1

record1id_task

task EntityType

task_connections1

record1id_team

team EntityType

team_connections1

record1id_territory

territory EntityType

territory_connections1

record1roleid

connectionrole EntityType

connection_role_connections1

record2id_account

account EntityType

account_connections2

record2id_activitypointer

activitypointer EntityType

activitypointer_connections2

record2id_appointment

appointment EntityType

appointment_connections2

record2id_campaign

campaign EntityType

campaign_connections2

record2id_campaignactivity

campaignactivity EntityType

campaignactivity_connections2

record2id_competitor

competitor EntityType

competitor_connections2

record2id_constraintbasedgroup

constraintbasedgroup EntityType

constraintbasedgroup_connections2

record2id_contact

contact EntityType

contact_connections2

record2id_contract

contract EntityType

contract_connections2

record2id_email

email EntityType

email_connections2

record2id_entitlement

entitlement EntityType

entitlement_connections2

record2id_equipment

equipment EntityType

equipment_connections2

record2id_fax

fax EntityType

fax_connections2

record2id_goal

goal EntityType

goal_connections2

record2id_incident

incident EntityType

incident_connections2

record2id_invoice

invoice EntityType

invoice_connections2

record2id_knowledgearticle

knowledgearticle EntityType

knowledgearticle_connections2

record2id_knowledgebaserecord

knowledgebaserecord EntityType

KnowledgeBaseRecord_connections2

record2id_lead

lead EntityType

lead_connections2

record2id_letter

letter EntityType

letter_connections2

record2id_list

list EntityType

list_connections2

record2id_opportunity

opportunity EntityType

opportunity_connections2

record2id_phonecall

phonecall EntityType

phonecall_connections2

record2id_position

position EntityType

position_connection2

record2id_pricelevel

pricelevel EntityType

pricelevel_connections2

record2id_product

product EntityType

product_connections2

record2id_quote

quote EntityType

quote_connections2

record2id_recurringappointmentmaster

recurringappointmentmaster EntityType

recurringappointmentmaster_connections2

record2id_resourcegroup

resourcegroup EntityType

resourcegroup_connections2

record2id_salesorder

salesorder EntityType

salesorder_connections2

record2id_serviceappointment

serviceappointment EntityType

serviceappointment_connections2

record2id_socialactivity

socialactivity EntityType

socialactivity_connections2

record2id_socialprofile

socialprofile EntityType

socialprofile_connections2

record2id_systemuser

systemuser EntityType

systemuser_connections2

record2id_task

task EntityType

task_connections2

record2id_team

team EntityType

team_connections2

record2id_territory

territory EntityType

territory_connections2

record2roleid

connectionrole EntityType

connection_role_connections2

relatedconnectionid

connection EntityType

connection_related_connection

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

regardingobjectid_connection

connection_related_connection

connection EntityType

relatedconnectionid

Connection_SyncErrors

syncerror EntityType

regardingobjectid_connection_syncerror

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright