connectionrole EntityType

Role describing a relationship between a two records.

Entity Set Path
[organization URI]/api/data/v9.2/connectionroles
Base Type
crmbaseentity
Display Name
Connection Role
Primary Key
connectionroleid
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
category Edm.Int32

Categories for connection roles.

Display Name: Connection Role Category

Default Options
Values Label
1 Business
2 Family
3 Social
4 Sales
5 Other
1000 Stakeholder
1001 Sales Team
1002 Service
componentstate Edm.Int32

State of the component.

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
connectionroleid Edm.Guid

Unique identifier of the connection role.

Display Name: Connection Role

connectionroleidunique Edm.Guid

Unique identifier of the published or unpublished connection role record.

Display Name: Unique ID

Read Only
createdon Edm.DateTimeOffset

Date and time when the connection role was created.

Display Name: Created On

Read Only
description Edm.String

Description of the connection role.

Display Name: Description

importsequencenumber Edm.Int32

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

Display Name: Import Sequence Number

introducedversion Edm.String

Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: State

Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the connection role was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the connection role.

Display Name: Name

overwritetime Edm.DateTimeOffset

Date and time when the record was last overwritten.

Display Name: Overwritten On

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the connection role.

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the connection role.

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
versionnumber Edm.Int64

Version number of the connection role.

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 relationship role.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the relationship role.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the connection role.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the relationship role.

_organizationid_value organizationid

Unique identifier of the organization that this connection role belongs to.

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_role
createdonbehalfby systemuser lk_connectionrolebase_createdonbehalfby
modifiedby systemuser modifiedby_connection_role
modifiedonbehalfby systemuser lk_connectionrolebase_modifiedonbehalfby
organizationid organization organization_connection_roles

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_Role_AsyncOperations asyncoperation regardingobjectid_connectionrole
connection_role_connections1 connection record1roleid
connection_role_connections2 connection record2roleid
ConnectionRole_ProcessSessions processsession regardingobjectid_connectionrole
ConnectionRole_SyncErrors syncerror regardingobjectid_connectionrole_syncerror
connectionroleassociation_association connectionrole connectionroleassociation_association_referenced
connectionroleassociation_association_referenced connectionrole connectionroleassociation_association

See also