Connection Role (ConnectionRole) table/entity reference
Role describing a relationship between a two records.
Messages
The following table lists the messages for the Connection Role (ConnectionRole) table. Messages represent operations that can be performed on the table. They may also be events.
Name Is Event? |
Web API Operation | SDK for .NET |
---|---|---|
Create Event: True |
POST /connectionrolesSee Create |
Create records |
Delete Event: True |
DELETE /connectionroles(connectionroleid)See Delete |
Delete records |
Retrieve Event: True |
GET /connectionroles(connectionroleid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: True |
GET /connectionrolesSee Query data |
Query data |
SetState Event: True |
PATCH /connectionroles(connectionroleid)Update the statecode and statuscode properties. |
SetStateRequest |
Update Event: True |
PATCH /connectionroles(connectionroleid)See Update |
Update records |
Upsert Event: False |
PATCH /connectionroles(connectionroleid)See Upsert a table row |
UpsertRequest |
Properties
The following table lists selected properties for the Connection Role (ConnectionRole) table.
Property | Value |
---|---|
DisplayName | Connection Role |
DisplayCollectionName | Connection Roles |
SchemaName | ConnectionRole |
CollectionSchemaName | ConnectionRoles |
EntitySetName | connectionroles |
LogicalName | connectionrole |
LogicalCollectionName | connectionroles |
PrimaryIdAttribute | connectionroleid |
PrimaryNameAttribute | name |
TableType | Standard |
OwnershipType | OrganizationOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- Category
- ConnectionRoleId
- Description
- ImportSequenceNumber
- IntroducedVersion
- IsCustomizable
- Name
- StateCode
- StatusCode
Category
Property | Value |
---|---|
Description | Categories for connection roles. |
DisplayName | Connection Role Category |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | category |
RequiredLevel | None |
Type | Picklist |
DefaultFormValue | 1 |
GlobalChoiceName | connectionrole_category |
Category Choices/Options
Value | Label |
---|---|
1 | Business |
2 | Family |
3 | Social |
4 | Sales |
5 | Other |
1000 | Stakeholder |
1001 | Sales Team |
1002 | Service |
ConnectionRoleId
Property | Value |
---|---|
Description | Unique identifier of the connection role. |
DisplayName | Connection Role |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | connectionroleid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Description
Property | Value |
---|---|
Description | Description of the connection role. |
DisplayName | Description |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | description |
RequiredLevel | None |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 1000 |
ImportSequenceNumber
Property | Value |
---|---|
Description | Unique identifier of the data import or data migration that created this record. |
DisplayName | Import Sequence Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | importsequencenumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -2147483648 |
IntroducedVersion
Property | Value |
---|---|
Description | Version in which the form is introduced. |
DisplayName | Introduced Version |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | introducedversion |
RequiredLevel | None |
Type | String |
Format | VersionNumber |
FormatName | VersionNumber |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 48 |
IsCustomizable
Property | Value |
---|---|
Description | Information that specifies whether this component can be customized. |
DisplayName | Customizable |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | iscustomizable |
RequiredLevel | SystemRequired |
Type | ManagedProperty |
Name
Property | Value |
---|---|
Description | Name of the connection role. |
DisplayName | Name |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | name |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
StateCode
Property | Value |
---|---|
Description | Status of the connection role. |
DisplayName | Status |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
DefaultFormValue | 0 |
GlobalChoiceName | connectionrole_statecode |
StateCode Choices/Options
Value | Details |
---|---|
0 | Label: Active DefaultStatus: 1 InvariantName: Active |
1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
StatusCode
Property | Value |
---|---|
Description | Reason for the status of the connection role. |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
DefaultFormValue | -1 |
GlobalChoiceName | connectionrole_statuscode |
StatusCode Choices/Options
Value | Details |
---|---|
1 | Label: Active State:0 TransitionData: None |
2 | Label: Inactive State:1 TransitionData: None |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- ComponentState
- ConnectionRoleIdUnique
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OrganizationId
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentState
Property | Value |
---|---|
Description | State of the component. |
DisplayName | Component State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | componentstate |
RequiredLevel | SystemRequired |
Type | Picklist |
DefaultFormValue | -1 |
GlobalChoiceName | componentstate |
ComponentState Choices/Options
Value | Label |
---|---|
0 | Published |
1 | Unpublished |
2 | Deleted |
3 | Deleted Unpublished |
ConnectionRoleIdUnique
Property | Value |
---|---|
Description | Unique identifier of the published or unpublished connection role record. |
DisplayName | Unique ID |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | connectionroleidunique |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
CreatedBy
Property | Value |
---|---|
Description | Unique identifier of the user who created the relationship role. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
CreatedOn
Property | Value |
---|---|
Description | Date and time when the connection role was created. |
DisplayName | Created On |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
CreatedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who created the relationship role. |
DisplayName | Created By (Delegate) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
IsManaged
Property | Value |
---|---|
Description | Indicates whether the solution component is part of a managed solution. |
DisplayName | State |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | ismanaged |
RequiredLevel | SystemRequired |
Type | Boolean |
GlobalChoiceName | ismanaged |
DefaultValue | False |
True Label | Managed |
False Label | Unmanaged |
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who last modified the connection role. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
ModifiedOn
Property | Value |
---|---|
Description | Date and time when the connection role was last modified. |
DisplayName | Modified On |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
ModifiedOnBehalfBy
Property | Value |
---|---|
Description | Unique identifier of the delegate user who modified the relationship role. |
DisplayName | Modified By (Delegate) |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedonbehalfby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
OrganizationId
Property | Value |
---|---|
Description | Unique identifier of the organization that this connection role belongs to. |
DisplayName | Organization |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationid |
RequiredLevel | SystemRequired |
Type | Lookup |
Targets | organization |
OverwriteTime
Property | Value |
---|---|
Description | Date and time when the record was last overwritten. |
DisplayName | Overwritten On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overwritetime |
RequiredLevel | SystemRequired |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateOnly |
ImeMode | Inactive |
SourceTypeMask | 0 |
SolutionId
Property | Value |
---|---|
Description | Unique identifier of the associated solution. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | solutionid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
SupportingSolutionId
Property | Value |
---|---|
Description | For internal use only. |
DisplayName | Solution |
IsValidForForm | False |
IsValidForRead | False |
LogicalName | supportingsolutionid |
RequiredLevel | None |
Type | Uniqueidentifier |
VersionNumber
Property | Value |
---|---|
Description | Version number of the connection role. |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- createdby_connection_role
- lk_connectionrolebase_createdonbehalfby
- lk_connectionrolebase_modifiedonbehalfby
- modifiedby_connection_role
- organization_connection_roles
createdby_connection_role
One-To-Many Relationship: systemuser createdby_connection_role
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdby |
ReferencingEntityNavigationPropertyName | createdby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_connectionrolebase_createdonbehalfby
One-To-Many Relationship: systemuser lk_connectionrolebase_createdonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdonbehalfby |
ReferencingEntityNavigationPropertyName | createdonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_connectionrolebase_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_connectionrolebase_modifiedonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedonbehalfby |
ReferencingEntityNavigationPropertyName | modifiedonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
modifiedby_connection_role
One-To-Many Relationship: systemuser modifiedby_connection_role
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedby |
ReferencingEntityNavigationPropertyName | modifiedby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
organization_connection_roles
One-To-Many Relationship: organization organization_connection_roles
Property | Value |
---|---|
ReferencedEntity | organization |
ReferencedAttribute | organizationid |
ReferencingAttribute | organizationid |
ReferencingEntityNavigationPropertyName | organizationid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
- Connection_Role_AsyncOperations
- connection_role_connections1
- connection_role_connections2
- ConnectionRole_ProcessSessions
- ConnectionRole_SyncErrors
Connection_Role_AsyncOperations
Many-To-One Relationship: asyncoperation Connection_Role_AsyncOperations
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | Connection_Role_AsyncOperations |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
connection_role_connections1
Many-To-One Relationship: connection connection_role_connections1
Property | Value |
---|---|
ReferencingEntity | connection |
ReferencingAttribute | record1roleid |
ReferencedEntityNavigationPropertyName | connection_role_connections1 |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
connection_role_connections2
Many-To-One Relationship: connection connection_role_connections2
Property | Value |
---|---|
ReferencingEntity | connection |
ReferencingAttribute | record2roleid |
ReferencedEntityNavigationPropertyName | connection_role_connections2 |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
ConnectionRole_ProcessSessions
Many-To-One Relationship: processsession ConnectionRole_ProcessSessions
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | ConnectionRole_ProcessSessions |
IsCustomizable | False |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 110 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
ConnectionRole_SyncErrors
Many-To-One Relationship: syncerror ConnectionRole_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | ConnectionRole_SyncErrors |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-to-Many relationships
These relationships are many-to-many. Listed by SchemaName.
connectionroleassociation_association
This is a self-referencing many-to-many relationship.
Property | Value |
---|---|
IntersectEntityName | connectionroleassociation |
IsCustomizable | False |
SchemaName | connectionroleassociation_association |
Entity1IntersectAttribute | connectionroleid |
Entity2IntersectAttribute | associatedconnectionroleid |
Entity1NavigationPropertyName | connectionroleassociation_association |
Entity2NavigationPropertyName | connectionroleassociation_association |
Entity1AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Entity2AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
connectionrole