Queue entity messages and methods

 

Applies To: Dynamics CRM 2013

A queue is a list of records requiring action, such as accounts, cases, and activities. The schema name for this entity is Queue. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AddPrincipalToQueueRequest	This message was added with CRM 2013 Service Pack 1 (on-premises) and CRM Online Spring ‘14. Adds the specified principal to the list of queue members. If the passed-in Principal is a team, add each team member to the queue.
AssignRequest	Assigns a queue to another user or team.
CreateRequest	Creates a queue. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a queue. You can also call the IOrganizationService.Delete method.
GrantAccessRequest	Shares a queue with another security principal (user or team).
ModifyAccessRequest	Changes the access rights for a queue previously shared with another security principal (user or team).
RetrieveRequest	Retrieves a queue. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of queues. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access rights the specified security principal (user or team) has to a queue.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a contract, together with their access rights to the queue.
RetrieveUserQueuesRequest	This message was added with CRM 2013 Service Pack 1 (on-premises) and CRM Online Spring ‘14. Retrieves all private queues of a specified user and optionally all public queues.
RevokeAccessRequest	Removes all access to a queue for the specified security principal (user or team).
SetStateRequest	Sets the state of a queue. For a list of the state values, see the options available in the metadata.You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates a queue. You can also call the IOrganizationService.Update method.

Note

The Queue.QueueTypeCode attribute exists for legacy purpose only. This attribute should not be used and any value stored in this attribute should be ignored.

See Also

Queue entities
Queue entity privileges
QueueItem entity messages and methods