queue EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Entity Set path:[organization URI]/api/data/v8.2/queues

Base Type: crmbaseentity EntityType

Display Name: Queue

Primary Key: queueid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to queue

Operations using the queue entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

createdon

Edm.DateTimeOffset

Description: Date and time when the queue was created.

Display Name: Created On

Read-only property

description

Edm.String

Description: Description of the queue.

Display Name: Description

emailaddress

Edm.String

Description: Email address that is associated with the queue.

Display Name: Incoming Email

emailrouteraccessapproval

Edm.Int32

Description: Shows the status of the primary email address.

Default Options:

0 : Empty
1 : Approved
2 : Pending Approval
3 : Rejected

Display Name: Primary Email Status

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

exchangerate

Edm.Decimal

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

Display Name: Exchange Rate

Read-only property

ignoreunsolicitedemail

Edm.Boolean

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

Default Options:

1 : Only specific Emails
0 : All incoming Emails

Display Name: Convert To Email Activities

importsequencenumber

Edm.Int32

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

Display Name: Import Sequence Number

incomingemaildeliverymethod

Edm.Int32

Description: Incoming email delivery method for the queue.

Default Options:

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

Display Name: Incoming Email Delivery Method

incomingemailfilteringmethod

Edm.Int32

Description: Convert Incoming Email To Activities

Default Options:

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

Display Name: Convert Incoming Email To Activities

isemailaddressapprovedbyo365admin

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Email Address O365 Admin Approval Status

Read-only property

modifiedon

Edm.DateTimeOffset

Description: Date and time when the queue was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the queue.

Display Name: Name

numberofitems

Edm.Int32

Description: Number of Queue items associated with the queue.

Display Name: Queue Items

Read-only property

numberofmembers

Edm.Int32

Description: Number of Members associated with the queue.

Display Name: No. of Members

Read-only property

outgoingemaildeliverymethod

Edm.Int32

Description: Outgoing email delivery method for the queue.

Default Options:

0 : None
2 : Server-Side Synchronization or Email Router

Display Name: Outgoing Email Delivery Method

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

queueid

Edm.Guid

Description: Unique identifier of the queue.

Display Name: Queue

queuetypecode

Edm.Int32

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.

Default Options:

1 : Default Value

Display Name: Queue Type

Read-only property

queueviewtype

Edm.Int32

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.

Default Options:

0 : Public
1 : Private

Display Name: Type

statecode

Edm.Int32

Description: Status of the queue.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Reason for the status of the queue.

Default Options:

2 : Inactive
1 : Active

Display Name: Status Reason

versionnumber

Edm.Int64

Description: Version number of the queue.

Display Name: Version Number

Read-only property

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

Unique identifier of the team who owns the queue.

_owninguser_value

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 EntityType

business_unit_queues

createdby

systemuser EntityType

lk_queuebase_createdby

createdonbehalfby

systemuser EntityType

lk_queue_createdonbehalfby

defaultmailbox

mailbox EntityType

queue_defaultmailbox_mailbox

modifiedby

systemuser EntityType

lk_queuebase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_queue_modifiedonbehalfby

organizationid

organization EntityType

organization_queues

ownerid

principal EntityType

owner_queues

owningbusinessunit

businessunit EntityType

business_unit_queues2

primaryuserid

systemuser EntityType

queue_primary_user

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

regardingobjectid_queue

queue_activity_parties

activityparty EntityType

partyid_queue

Queue_AsyncOperations

asyncoperation EntityType

regardingobjectid_queue

Queue_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_queue

Queue_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_queue

Queue_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_queue

Queue_Email_EmailSender

email EntityType

emailsender_queue

queue_entries

queueitem EntityType

queueid

queue_PostFollows

postfollow EntityType

regardingobjectid_queue

queue_PostRegardings

postregarding EntityType

regardingobjectid_queue

Queue_SyncErrors

syncerror EntityType

regardingobjectid_queue_syncerror

queue_system_user

systemuser EntityType

queueid

queue_team

team EntityType

queueid

queuemembership_association

systemuser EntityType

queuemembership_association

Operations bound to queue

The following operations are bound to the queue entity type.

Name

Bound to

AddPrincipalToQueue Action

Entity

AddToQueue Action

Entity

Operations using the queue entity type.

The following operations use the queue entity type in a parameter or return type.

Name

How used

Description

AddPrincipalToQueue Action

entity Parameter

Adds the specified principal to the list of queue members.

AddToQueue Action

entity Parameter

Moves an entity record from a source queue to a destination queue.

AddToQueue Action

SourceQueue Parameter

Moves an entity record from a source queue to a destination queue.

DistributeCampaignActivity Action

Queue Parameter

Creates a bulk operation that distributes a campaign activity.

RetrieveUserQueues Function

ReturnType

Retrieves all private queues of a specified user and optionally all public queues.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright