EntitlementChannel Entity Reference

Defines the amount and type of support for a channel.

Added by: Service Solution

Messages

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

Entity Properties

Property Value
CollectionSchemaName EntitlementChannels
DisplayCollectionName Entitlement Channels
DisplayName Entitlement Channel
EntitySetName entitlementchannels
IsBPFEntity False
LogicalCollectionName entitlementchannels
LogicalName entitlementchannel
OwnershipType UserOwned
PrimaryIdAttribute entitlementchannelid
PrimaryNameAttribute name
SchemaName EntitlementChannel

Writable attributes

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

Channel

Property Value
Description Select a channel for which you are defining the entitlement terms.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName channel
RequiredLevel SystemRequired
Type Picklist

Channel Options

Value Label
1 Phone
2 Email
3 Web
2483 Facebook
3986 Twitter

EntitlementChannelId

Property Value
Description Unique identifier for entity instances
DisplayName Entitlement Channel
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName entitlementchannelid
RequiredLevel SystemRequired
Type Uniqueidentifier

EntitlementId

Property Value
Description Unique identifier for Entitlement associated with Entitlement Channel.
DisplayName Entitlement
IsValidForForm True
IsValidForRead True
LogicalName entitlementid
RequiredLevel ApplicationRequired
Targets entitlement
Type Lookup

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 The name of the custom entity.
DisplayName Entitlement Channel Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel None
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

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName ownerid
RequiredLevel None
Targets systemuser,team
Type Owner

RemainingTerms

Property Value
Description Type the total number of entitlement terms that are left.
DisplayName Remaining Terms
IsValidForForm True
IsValidForRead True
LogicalName remainingterms
MaxValue 100000000000
MinValue -100000000000
Precision 2
RequiredLevel None
Type Decimal

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

TotalTerms

Property Value
Description Type the total number of entitlement terms.
DisplayName Total Terms
IsValidForForm True
IsValidForRead True
LogicalName totalterms
MaxValue 100000000000
MinValue 0
Precision 2
RequiredLevel None
Type Decimal

TransactionCurrencyId

Property Value
Description Unique identifier of the currency associated with the incident.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

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.

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
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 record 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 record.
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

EntitlementIdName

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

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the incident with respect to the base currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
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 record was 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 modified the record.
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 with which the entitlement channel is associated.
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

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel ApplicationRequired
Targets
Type Lookup

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel ApplicationRequired
Targets
Type Lookup

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
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.

entitlementchannel_SyncErrors

Added by: System Solution Solution

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

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

entitlementchannel_AsyncOperations

Added by: System Solution Solution

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

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

entitlementchannel_MailboxTrackingFolders

Added by: System Solution Solution

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

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

entitlementchannel_BulkDeleteFailures

Added by: System Solution Solution

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

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

entitlementchannel_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

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

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

entitlementchannel_connections1

Added by: System Solution Solution

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

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

entitlementchannel_connections2

Added by: System Solution Solution

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

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

entitlementchannel_Annotations

Added by: System Solution Solution

Same as annotation entity entitlementchannel_Annotations Many-To-One relationship.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName entitlementchannel_Annotations
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

entitlementchannel_ProcessSession

Added by: System Solution Solution

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

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

entitlementchannel_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord entity entitlementchannel_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName entitlementchannel_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

entitlementchannel_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord entity entitlementchannel_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName entitlementchannel_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
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_entitlementchannel_createdby

Added by: System Solution Solution

See systemuser Entity lk_entitlementchannel_createdby One-To-Many relationship.

lk_entitlementchannel_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_entitlementchannel_createdonbehalfby One-To-Many relationship.

lk_entitlementchannel_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_entitlementchannel_modifiedby One-To-Many relationship.

lk_entitlementchannel_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_entitlementchannel_modifiedonbehalfby One-To-Many relationship.

user_entitlementchannel

Added by: System Solution Solution

See systemuser Entity user_entitlementchannel One-To-Many relationship.

team_entitlementchannel

Added by: System Solution Solution

See team Entity team_entitlementchannel One-To-Many relationship.

entitlement_entitlementchannel_EntitlementId

See entitlement Entity entitlement_entitlementchannel_EntitlementId One-To-Many relationship.

entitlementchannel_organization

Added by: System Solution Solution

See organization Entity entitlementchannel_organization One-To-Many relationship.

TransactionCurrency_entitlementchannel

Added by: System Solution Solution

See transactioncurrency Entity TransactionCurrency_entitlementchannel One-To-Many relationship.

See also

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