Breyta

Deila með

Queue Entity Reference (Dynamics 365 Customer Service)

  • Grein

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse. A list of records that require action, such as accounts, activities, and cases.

Messages

Message Web API Operation SDK Assembly
AddPrincipalToQueue AddPrincipalToQueue Action AddPrincipalToQueueRequest
Assign PATCH [org URI]/api/data/v9.0/queues(queueid)
Update ownerid property.		 AssignRequest
Create POST [org URI]/api/data/v9.0/queues
See Create		 CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/queues(queueid)
See Delete		 DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/queues(queueid)
See Retrieve		 RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/queues
See Query Data		 RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RetrieveUserQueues RetrieveUserQueues Function RetrieveUserQueuesRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/queues(queueid)
Update statecode and statuscode properties.		 SetStateRequest
Update PATCH [org URI]/api/data/v9.0/queues(queueid)
See Update		 UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName Queues
DisplayCollectionName Queues
DisplayName Queue
EntitySetName queues
IsBPFEntity False
LogicalCollectionName queues
LogicalName queue
OwnershipType UserOwned
PrimaryIdAttribute queueid
PrimaryNameAttribute name
SchemaName Queue

Writable columns/attributes

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

BusinessUnitId

Property Value
Description Unique identifier of the business unit with which the queue is associated.
DisplayName Business Unit
IsValidForForm False
IsValidForRead True
LogicalName businessunitid
RequiredLevel None
Targets businessunit
Type Lookup

Description

Property Value
Description Description of the queue.
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

EMailAddress

Property Value
Description Email address that is associated with the queue.
DisplayName Incoming Email
FormatName Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailaddress
MaxLength 100
RequiredLevel None
Type String

EmailRouterAccessApproval

Property Value
Description Shows the status of the primary email address.
DisplayName Primary Email Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName emailrouteraccessapproval
RequiredLevel SystemRequired
Type Picklist

EmailRouterAccessApproval Choices/Options

Value Label
0 Empty
1 Approved
2 Pending Approval
3 Rejected

EntityImage

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage True
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

IgnoreUnsolicitedEmail

Property Value
Description Information that specifies whether a queue is to ignore unsolicited email (deprecated).
DisplayName Convert To Email Activities
IsValidForForm True
IsValidForRead True
LogicalName ignoreunsolicitedemail
RequiredLevel None
Type Boolean

IgnoreUnsolicitedEmail Choices/Options

Value Label
1 Only specific Emails
0 All incoming Emails

DefaultValue: False

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration 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

IncomingEmailDeliveryMethod

Property Value
Description Incoming email delivery method for the queue.
DisplayName Incoming Email Delivery Method
IsValidForForm True
IsValidForRead True
LogicalName incomingemaildeliverymethod
RequiredLevel SystemRequired
Type Picklist

IncomingEmailDeliveryMethod Choices/Options

Value Label
0 None
2 Server-Side Synchronization or Email Router
3 Forward Mailbox

IncomingEmailFilteringMethod

Property Value
Description Convert Incoming Email To Activities
DisplayName Convert Incoming Email To Activities
IsValidForForm True
IsValidForRead True
LogicalName incomingemailfilteringmethod
RequiredLevel SystemRequired
Type Picklist

IncomingEmailFilteringMethod Choices/Options

Value Label
0 All email messages
1 Email messages in response to Dynamics 365 email
2 Email messages from Dynamics 365 Leads, Contacts and Accounts
3 Email messages from Dynamics 365 records that are email enabled
4 No email messages

msdyn_assignmentinputcontractid

Added by: Dynamics 365 UR OmnichanelBase Dependency Solution

Property Value
Description Link assignment input contract with queue.
DisplayName Assignment Input Contract Id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_assignmentinputcontractid
RequiredLevel None
Targets msdyn_decisioncontract
Type Lookup

msdyn_assignmentstrategy

Added by: Dynamics 365 UR OmnichanelBase Dependency Solution

Property Value
Description
DisplayName Assignment Strategy
IsValidForForm True
IsValidForRead True
LogicalName msdyn_assignmentstrategy
RequiredLevel None
Type Picklist

msdyn_assignmentstrategy Choices/Options

Value Label
192350000 Omnichannel Assignment
192350001 Round Robin
192350002 Custom Assignment Configuration

msdyn_isdefaultqueue

Added by: Omnichannel – Base Solution

Property Value
Description Shows whether the queue is set as default or not.
DisplayName Is Default Queue
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isdefaultqueue
RequiredLevel None
Type Boolean

msdyn_isdefaultqueue Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_isomnichannelqueue

Added by: Omnichannel – Base Solution

Property Value
Description Shows whether the queue is used as Omnichannel queue for work distribution.
DisplayName Is Omnichannel queue
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isomnichannelqueue
RequiredLevel ApplicationRequired
Type Boolean

msdyn_isomnichannelqueue Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_maxqueuesize

Added by: Omnichannel - Base Patch Solution

Property Value
Description Maximum queue size
DisplayName Maximum queue size
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_maxqueuesize
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

msdyn_operatinghourid

Added by: Omnichannel - Base Patch Solution

Property Value
Description Unique identifier for Operating hour associated with Queue
DisplayName Operating Hours
IsValidForForm True
IsValidForRead True
LogicalName msdyn_operatinghourid
RequiredLevel None
Targets msdyn_operatinghour
Type Lookup

msdyn_priority

Added by: Omnichannel – Base Solution

Property Value
Description Priority of the queue to indicate conversation assignment order to the agent.
DisplayName Priority
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_priority
MaxValue 2147483647
MinValue 1
RequiredLevel ApplicationRequired
Type Integer

msdyn_queuetype

Added by: Omnichannel - Base Patch Solution

Property Value
Description Defines the type of channels handled by this queue
DisplayName Queue type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_queuetype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_queuetype Choices/Options

Value Label
192350000 Messaging
192350001 Entity
192350002 Voice

msdyn_uniquename

Added by: Omnichannel - Base Patch Solution

Property Value
Description Unique Name for the entity.
DisplayName Unique Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_uniquename
MaxLength 128
RequiredLevel None
Type String

Name

Property Value
Description Name of the queue.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName name
MaxLength 200
RequiredLevel ApplicationRequired
Type String

OutgoingEmailDeliveryMethod

Property Value
Description Outgoing email delivery method for the queue.
DisplayName Outgoing Email Delivery Method
IsValidForForm True
IsValidForRead True
LogicalName outgoingemaildeliverymethod
RequiredLevel SystemRequired
Type Picklist

OutgoingEmailDeliveryMethod Choices/Options

Value Label
0 None
2 Server-Side Synchronization or Email Router

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 Unique identifier of the user or team who owns the queue.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

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

PrimaryUserId

Property Value
Description Unique identifier of the owner of the queue.
DisplayName Owner (deprecated)
IsValidForForm False
IsValidForRead True
LogicalName primaryuserid
RequiredLevel None
Targets systemuser
Type Lookup

QueueId

Property Value
Description Unique identifier of the queue.
DisplayName Queue
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName queueid
RequiredLevel SystemRequired
Type Uniqueidentifier

QueueViewType

Property Value
Description Select whether the queue is public or private. A public queue can be viewed by all. A private queue can be viewed only by the members added to the queue.
DisplayName Type
IsValidForForm True
IsValidForRead True
LogicalName queueviewtype
RequiredLevel SystemRequired
Type Picklist

QueueViewType Choices/Options

Value Label
0 Public
1 Private

StateCode

Property Value
Description Status of the queue.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Reason for the status of the queue.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel SystemRequired
Type Status

StatusCode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TransactionCurrencyId

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

Read-only columns/attributes

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

AllowEmailCredentials

Property Value
Description This attribute is no longer used. The data is now in the Mailbox.AllowEmailConnectorToUseCredentials attribute.
DisplayName Allow to Use Credentials for Email Processing (Obsolete)
IsValidForForm True
IsValidForRead True
LogicalName allowemailcredentials
RequiredLevel SystemRequired
Type Boolean

AllowEmailCredentials Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

BusinessUnitIdName

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

CreatedBy

Property Value
Description Unique identifier of the user who created the queue 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 queue 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 queue.
DisplayName Created By (Delegate)
IsValidForForm False
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

DefaultMailbox

Property Value
Description Select the mailbox associated with this queue.
DisplayName Mailbox
IsValidForForm True
IsValidForRead True
LogicalName defaultmailbox
RequiredLevel None
Targets mailbox
Type Lookup

DefaultMailboxName

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

EmailPassword

Property Value
Description This attribute is no longer used. The data is now in the Mailbox.Password attribute.
DisplayName Password (Obsolete)
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailpassword
MaxLength 200
RequiredLevel None
Type String

EmailUsername

Property Value
Description This attribute is no longer used. The data is now in the Mailbox.UserName attribute.
DisplayName User Name (Obsolete)
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailusername
MaxLength 200
RequiredLevel None
Type String

EntityImage_Timestamp

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

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description For internal use only.
DisplayName Entity Image Id
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the queue 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

IsEmailAddressApprovedByO365Admin

Property Value
Description Shows the status of approval of the email address by O365 Admin.
DisplayName Email Address O365 Admin Approval Status
IsValidForForm False
IsValidForRead True
LogicalName isemailaddressapprovedbyo365admin
RequiredLevel SystemRequired
Type Boolean

IsEmailAddressApprovedByO365Admin Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

IsFaxQueue

Property Value
Description Indication of whether a queue is the fax delivery queue.
DisplayName Fax Queue
IsValidForForm False
IsValidForRead True
LogicalName isfaxqueue
RequiredLevel None
Type Boolean

IsFaxQueue Choices/Options

Value Label
1 Fax Queue
0 Non-fax Queue

DefaultValue: False

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the queue.
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 queue 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 queue.
DisplayName Modified By (Delegate)
IsValidForForm False
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

msdyn_assignmentinputcontractidName

Added by: Dynamics 365 UR OmnichanelBase Dependency Solution

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

msdyn_operatinghouridName

Added by: Omnichannel - Base Patch Solution

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

NumberOfItems

Property Value
Description Number of Queue items associated with the queue.
DisplayName Queue Items
Format None
IsValidForForm False
IsValidForRead True
LogicalName numberofitems
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

NumberOfMembers

Property Value
Description Number of Members associated with the queue.
DisplayName No. of Members
Format None
IsValidForForm False
IsValidForRead True
LogicalName numberofmembers
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

OrganizationId

Property Value
Description Unique identifier of the organization associated with the queue.
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
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

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

OwningBusinessUnit

Property Value
Description Unique identifier of the business unit that owns the queue.
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier of the team who owns the queue.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier of the user who owns the queue.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

PrimaryUserIdName

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

PrimaryUserIdYomiName

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

QueueTypeCode

Property Value
Description Type of queue that is automatically assigned when a user or queue is created. The type can be public, private, or work in process.
DisplayName Queue Type
IsValidForForm False
IsValidForRead True
LogicalName queuetypecode
RequiredLevel None
Type Picklist

QueueTypeCode Choices/Options

Value Label
1 Default Value

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 of the queue.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

About the Entity Reference
Web API Reference