ConstraintBasedGroup Entity Reference

Group or collection of people, equipment, and/or facilities that can be scheduled.

Added by: Service Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/constraintbasedgroups
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/constraintbasedgroups(constraintbasedgroupid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/constraintbasedgroups(constraintbasedgroupid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/constraintbasedgroups
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/constraintbasedgroups(constraintbasedgroupid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName ConstraintBasedGroups
DisplayCollectionName Resource Groups
DisplayName Resource Group
EntitySetName constraintbasedgroups
IsBPFEntity False
LogicalCollectionName constraintbasedgroups
LogicalName constraintbasedgroup
OwnershipType BusinessOwned
PrimaryIdAttribute constraintbasedgroupid
PrimaryNameAttribute name
SchemaName ConstraintBasedGroup

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

BusinessUnitId

Property Value
Description Shows the business unit that the record owner belongs to.
DisplayName Business Unit
IsValidForForm True
IsValidForRead True
LogicalName businessunitid
RequiredLevel SystemRequired
Targets businessunit
Type Lookup

ConstraintBasedGroupId

Property Value
Description Unique identifier of the resource group.
DisplayName Resource Group
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName constraintbasedgroupid
RequiredLevel SystemRequired
Type Uniqueidentifier

Constraints

Property Value
Description Shows the constraints defined for the users, equipment, teams, and other resource groups included as resources for the group, stored in XML format.
DisplayName Constraints
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName constraints
MaxLength 1073741823
RequiredLevel SystemRequired
Type String

Description

Property Value
Description Type additional information to describe the resource group, such as the intended use or associated resource types.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

GroupTypeCode

Property Value
Description Shows whether the resource group is static, dynamic or hidden. Hidden groups are for system use only and are not viewable in Microsoft Dynamics 365.
DisplayName Group Type
IsValidForForm True
IsValidForRead True
LogicalName grouptypecode
RequiredLevel SystemRequired
Type Picklist

GroupTypeCode Options

Value Label
0 Static
1 Dynamic
2 Hidden

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Name

Property Value
Description Type a title or name that describes the resource group.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 160
RequiredLevel SystemRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

BusinessUnitIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName businessunitidname
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedBy

Property Value
Description Unique identifier of the user who created the resource group.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the resource group was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the constraintbasedgroup.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the resource group.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the resource group was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the constraintbasedgroup.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Property Value
Description Unique identifier of the organization associated with the resource group.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

constraintbasedgroup_SyncErrors

Added by: System Solution Solution

Same as syncerror entity constraintbasedgroup_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName constraintbasedgroup_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ConstraintBasedGroup_AsyncOperations

Added by: System Solution Solution

Same as asyncoperation entity ConstraintBasedGroup_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ConstraintBasedGroup_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

constraintbasedgroup_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder entity constraintbasedgroup_MailboxTrackingFolders Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName constraintbasedgroup_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ConstraintBasedGroup_ProcessSessions

Added by: System Solution Solution

Same as processsession entity ConstraintBasedGroup_ProcessSessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ConstraintBasedGroup_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

ConstraintBasedGroup_BulkDeleteFailures

Added by: System Solution Solution

Same as bulkdeletefailure entity ConstraintBasedGroup_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName ConstraintBasedGroup_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

constraintbasedgroup_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess entity constraintbasedgroup_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName constraintbasedgroup_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

constraintbasedgroup_connections1

Added by: System Solution Solution

Same as connection entity constraintbasedgroup_connections1 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record1id
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName constraintbasedgroup_connections1
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

constraintbasedgroup_connections2

Added by: System Solution Solution

Same as connection entity constraintbasedgroup_connections2 Many-To-One relationship.

Property Value
ReferencingEntity connection
ReferencingAttribute record2id
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName constraintbasedgroup_connections2
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 100
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

constraintbasedgroup_resource_groups

Same as resourcegroup entity constraintbasedgroup_resource_groups Many-To-One relationship.

Property Value
ReferencingEntity resourcegroup
ReferencingAttribute resourcegroupid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName constraintbasedgroup_resource_groups
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

constraint_based_group_resource_specs

Same as resourcespec entity constraint_based_group_resource_specs Many-To-One relationship.

Property Value
ReferencingEntity resourcespec
ReferencingAttribute groupobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName constraint_based_group_resource_specs
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_constraintbasedgroup_createdby

Added by: System Solution Solution

See systemuser Entity lk_constraintbasedgroup_createdby One-To-Many relationship.

lk_constraintbasedgroup_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_constraintbasedgroup_createdonbehalfby One-To-Many relationship.

lk_constraintbasedgroup_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_constraintbasedgroup_modifiedby One-To-Many relationship.

lk_constraintbasedgroup_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_constraintbasedgroup_modifiedonbehalfby One-To-Many relationship.

business_unit_constraint_based_groups

Added by: System Solution Solution

See businessunit Entity business_unit_constraint_based_groups One-To-Many relationship.

organization_constraint_based_groups

Added by: System Solution Solution

See organization Entity organization_constraint_based_groups One-To-Many relationship.

constraintbasedgroup_systemuser

Added by: System Solution Solution

See systemuser Entity constraintbasedgroup_systemuser One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
constraintbasedgroup EntityType