queueitem EntityType

 

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

Description: A specific item in a queue, such as a case record or an activity record.

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

Base Type: crmbaseentity EntityType

Display Name: Queue Item

Primary Key: queueitemid

Primary Name Attribute: title

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to queueitem

Operations using the queueitem entity type.

Properties

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

Name

Type

Details

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read-only property

enteredon

Edm.DateTimeOffset

Description: Shows the date the record was assigned to the queue.

Display Name: Entered Queue

Read-only property

exchangerate

Edm.Decimal

Description: Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read-only property

importsequencenumber

Edm.Int32

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

Display Name: Import Sequence Number

modifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read-only property

objecttypecode

Edm.Int32

Description: Select the type of the queue item, such as activity, case, or appointment.

Default Options:

4201 : Appointment
4402 : Campaign Activity
112 : Case
4406 : Quick Campaign
4202 : Email
4401 : Campaign Response
4251 : Recurring Appointment
9953 : Knowledge Article
4200 : Activity
4214 : Service Activity
4212 : Task
4204 : Fax
4216 : Social Activity
4207 : Letter
4210 : Phone Call

Display Name: Type

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

queueitemid

Edm.Guid

Description: Unique identifier of the queue item.

Display Name: Queue Item

statecode

Edm.Int32

Description: Shows whether the queue record is active or inactive. Inactive queue records are read-only and can't be edited unless they are reactivated.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Select the item's status.

Default Options:

2 : Inactive
1 : Active

Display Name: Status Reason

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

title

Edm.String

Description: Shows the title or name that describes the queue record. This value is copied from the record that was assigned to the queue.

Display Name: Title

Read-only property

utcconversiontimezonecode

Edm.Int32

Description: Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the queue item.

Display Name: Version Number

Read-only property

workeridmodifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the queue item was last assigned to a user.

Display Name: Worked On

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

Shows who created the record.

_createdonbehalfby_value

createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value

modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value

modifiedonbehalfby

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

_objectid_value

objectid_knowledgearticle

objectid_activitypointer

objectid_incident

Choose the activity, case, or article assigned to the queue.

_organizationid_value

organizationid

Unique identifier of the organization with which the queue item is associated.

_ownerid_value

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

_owningbusinessunit_value

Unique identifier of the business unit that owns the queue item.

_owninguser_value

Unique identifier of the user who owns the queue item.

_queueid_value

queueid

Choose the queue that the item is assigned to.

_transactioncurrencyid_value

transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

_workerid_value

workerid_systemuser

workerid_team

Shows who is working on the queue item.

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

createdby

systemuser EntityType

lk_queueitembase_createdby

createdonbehalfby

systemuser EntityType

lk_queueitem_createdonbehalfby

modifiedby

systemuser EntityType

lk_queueitembase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_queueitem_modifiedonbehalfby

objectid_activitypointer

activitypointer EntityType

ActivityPointer_QueueItem

objectid_appointment

appointment EntityType

Appointment_QueueItem

objectid_bulkoperation

bulkoperation EntityType

BulkOperation_QueueItem

objectid_campaignactivity

campaignactivity EntityType

CampaignActivity_QueueItem

objectid_campaignresponse

campaignresponse EntityType

CampaignResponse_QueueItem

objectid_email

email EntityType

Email_QueueItem

objectid_fax

fax EntityType

Fax_QueueItem

objectid_incident

incident EntityType

Incident_QueueItem

objectid_knowledgearticle

knowledgearticle EntityType

knowledgearticle_QueueItems

objectid_letter

letter EntityType

Letter_QueueItem

objectid_phonecall

phonecall EntityType

PhoneCall_QueueItem

objectid_recurringappointmentmaster

recurringappointmentmaster EntityType

RecurringAppointmentMaster_QueueItem

objectid_serviceappointment

serviceappointment EntityType

ServiceAppointment_QueueItem

objectid_socialactivity

socialactivity EntityType

SocialActivity_QueueItem

objectid_task

task EntityType

Task_QueueItem

organizationid

organization EntityType

organization_queueitems

queueid

queue EntityType

queue_entries

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_QueueItem

workerid_systemuser

systemuser EntityType

lk_queueitembase_workerid

workerid_team

team EntityType

team_queueitembase_workerid

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

QueueItem_AsyncOperations

asyncoperation EntityType

regardingobjectid_queueitem

QueueItem_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_queueitem

QueueItem_SyncErrors

syncerror EntityType

regardingobjectid_queueitem_syncerror

Operations bound to queueitem

The following operations are bound to the queueitem entity type.

Name

Bound to

PickFromQueue Action

Entity

ReleaseToQueue Action

Entity

RemoveFromQueue Action

Entity

Operations using the queueitem entity type.

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

Name

How used

Description

AddToQueue Action

QueueItemProperties Parameter

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

PickFromQueue Action

entity Parameter

Assigns a queue item to a user and optionally remove the queue item from the queue.

ReleaseToQueue Action

entity Parameter

Assigns a queue item back to the queue owner so others can pick it.

RemoveFromQueue Action

entity Parameter

Removes a queue item from a queue.

RouteTo Action

QueueItem Parameter

Routes a queue item to a queue, a user, or a team.

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