queue EntityType

A list of records that require action, such as accounts, activities, and cases.

Entity Set Path
[organization URI]/api/data/v9.0/queues
Base Type
crmbaseentity
Display Name
Queue
Primary Key
queueid
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
createdon Edm.DateTimeOffset

Date and time when the queue was created.

Display Name: Created On

Read Only
description Edm.String

Description of the queue.

Display Name: Description

emailaddress Edm.String

Email address that is associated with the queue.

Display Name: Incoming Email

emailrouteraccessapproval Edm.Int32

Shows the status of the primary email address.

Display Name: Primary Email Status

Default Options
Value Label
0 Empty
1 Approved
2 Pending Approval
3 Rejected
entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid

For internal use only.

Display Name: Entity Image Id

Read Only
exchangerate Edm.Decimal

Exchange rate for the currency associated with the queue with respect to the base currency.

Display Name: Exchange Rate

Read Only
ignoreunsolicitedemail Edm.Boolean

Information that specifies whether a queue is to ignore unsolicited email (deprecated).

Display Name: Convert To Email Activities

Default Options
Value Label
1 Only specific Emails
0 All incoming Emails
importsequencenumber Edm.Int32

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

Display Name: Import Sequence Number

incomingemaildeliverymethod Edm.Int32

Incoming email delivery method for the queue.

Display Name: Incoming Email Delivery Method

Default Options
Value Label
0 None
2 Server-Side Synchronization or Email Router
3 Forward Mailbox
incomingemailfilteringmethod Edm.Int32

Convert Incoming Email To Activities

Display Name: Convert Incoming Email To Activities

Default 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
isemailaddressapprovedbyo365admin Edm.Boolean

Shows the status of approval of the email address by O365 Admin.

Display Name: Email Address O365 Admin Approval Status

Read Only
Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Date and time when the queue was last modified.

Display Name: Modified On

Read Only
name Edm.String

Name of the queue.

Display Name: Name

numberofitems Edm.Int32

Number of Queue items associated with the queue.

Display Name: Queue Items

Read Only
numberofmembers Edm.Int32

Number of Members associated with the queue.

Display Name: No. of Members

Read Only
outgoingemaildeliverymethod Edm.Int32

Outgoing email delivery method for the queue.

Display Name: Outgoing Email Delivery Method

Default Options
Value Label
0 None
2 Server-Side Synchronization or Email Router
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

queueid Edm.Guid

Unique identifier of the queue.

Display Name: Queue

queuetypecode Edm.Int32

Type of queue that is automatically assigned when a user or queue is created. The type can be public, private, or work in process.

Display Name: Queue Type

Read Only
Default Options
Value Label
1 Default Value
queueviewtype Edm.Int32

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.

Display Name: Type

Default Options
Value Label
0 Public
1 Private
statecode Edm.Int32

Status of the queue.

Display Name: Status

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

Reason for the status of the queue.

Display Name: Status Reason

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

Version number of the queue.

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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the queue record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the queue.

_defaultmailbox_value defaultmailbox

Select the mailbox associated with this queue.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the queue.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the queue.

_organizationid_value organizationid

Unique identifier of the organization associated with the queue.

_ownerid_value ownerid

Unique identifier of the user or team who owns the queue.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the queue.

_owningteam_value createdby

Unique identifier of the team who owns the queue.

_owninguser_value createdby

Unique identifier of the user who owns the queue.

_transactioncurrencyid_value transactioncurrencyid

Unique identifier of the currency associated with the queue.

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
businessunitid businessunit business_unit_queues
createdby systemuser lk_queuebase_createdby
createdonbehalfby systemuser lk_queue_createdonbehalfby
defaultmailbox mailbox queue_defaultmailbox_mailbox
modifiedby systemuser lk_queuebase_modifiedby
modifiedonbehalfby systemuser lk_queue_modifiedonbehalfby
organizationid organization organization_queues
ownerid principal owner_queues
owningbusinessunit businessunit business_unit_queues2
primaryuserid systemuser queue_primary_user
transactioncurrencyid transactioncurrency TransactionCurrency_Queue

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
mailbox_regarding_queue mailbox regardingobjectid_queue
queue_activity_parties activityparty partyid_queue
Queue_AsyncOperations asyncoperation regardingobjectid_queue
Queue_BulkDeleteFailures bulkdeletefailure regardingobjectid_queue
Queue_DuplicateBaseRecord duplicaterecord baserecordid_queue
Queue_DuplicateMatchingRecord duplicaterecord duplicaterecordid_queue
Queue_Email_EmailSender email emailsender_queue
queue_entries queueitem queueid
queue_PostFollows postfollow regardingobjectid_queue
queue_PostRegardings postregarding regardingobjectid_queue
queue_principalobjectattributeaccess principalobjectattributeaccess objectid_queue
Queue_ProcessSessions processsession regardingobjectid_queue
Queue_SyncErrors syncerror regardingobjectid_queue_syncerror
queue_system_user systemuser queueid
queue_team team queueid
queuemembership_association systemuser queuemembership_association

Operations

The following operations can be used with the queue entity type.

Name Binding
AddPrincipalToQueue Entity
AddToQueue Entity
GrantAccess Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RetrieveUserQueues Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the queue entity type.

Name Description
Application Common Patch For internal use only.
Second Patch for Application Common For internal use only.
System Solution Internal CRM System Solution

See also