QueueItem entity reference

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

Messages

Message SDK class or method
AddToQueue AddToQueueRequest
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
PickFromQueue PickFromQueueRequest
ReleaseToQueue ReleaseToQueueRequest
RemoveFromQueue RemoveFromQueueRequest
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
RouteTo RouteToRequest
SetState SetStateRequest
Update UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName QueueItems
DisplayCollectionName Queue Items
DisplayName Queue Item
EntitySetName queueitems
IsBPFEntity False
LogicalCollectionName queueitems
LogicalName queueitem
OwnershipType None
PrimaryIdAttribute queueitemid
PrimaryNameAttribute title
SchemaName QueueItem

Writable attributes

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

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

ObjectId

Property Value
Description Choose the activity, case, or article assigned to the queue.
DisplayName Object
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName objectid
RequiredLevel ApplicationRequired
Targets activitypointer,appointment,bulkoperation,campaignactivity,campaignresponse,email,fax,incident,knowledgearticle,letter,phonecall,recurringappointmentmaster,serviceappointment,socialactivity,task
Type Lookup

ObjectIdTypeCode

Property Value
Description
DisplayName Regarding Object Type
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName objectidtypecode
RequiredLevel None
Type EntityName

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

Priority

Property Value
Description Priority of the queue item.
DisplayName Priority
Format None
IsValidForForm False
IsValidForRead True
LogicalName priority
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

QueueId

Property Value
Description Choose the queue that the item is assigned to.
DisplayName Queue
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName queueid
RequiredLevel ApplicationRequired
Targets queue
Type Lookup

QueueItemId

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

Sender

Property Value
Description Sender who created the queue item.
DisplayName From
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName sender
MaxLength 250
RequiredLevel None
Type String

State

Property Value
Description Status of the queue item.
DisplayName Status (deprecated)
Format None
IsValidForForm False
IsValidForRead True
LogicalName state
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

StateCode

Property Value
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.
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

Status

Property Value
Description Reason for the status of the queue item.
DisplayName Status Reason (deprecated)
Format None
IsValidForForm False
IsValidForRead True
LogicalName status
MaxValue 1000000000
MinValue 0
RequiredLevel None
Type Integer

StatusCode

Property Value
Description Select the item's status.
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

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

ToRecipients

Property Value
Description Recipients listed on the To line of the message for email queue items.
DisplayName To
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName torecipients
MaxLength 500
RequiredLevel None
Type String

TransactionCurrencyId

Property Value
Description Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

WorkerId

Property Value
Description Shows who is working on the queue item.
DisplayName Worked By
IsValidForForm True
IsValidForRead True
LogicalName workerid
RequiredLevel None
Targets systemuser,team
Type Lookup

WorkerIdType

Property Value
Description
DisplayName Worker Type
IsValidForForm False
IsValidForRead True
LogicalName workeridtype
RequiredLevel ApplicationRequired
Type EntityName

Read-only attributes

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

CreatedBy

Property Value
Description Shows who created the 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 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.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
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

EnteredOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date the record was assigned to the queue.
DisplayName Entered Queue
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName enteredon
RequiredLevel None
Type DateTime

ExchangeRate

Property Value
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.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

ModifiedBy

Property Value
Description Shows who last updated the record.
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 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.
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 queueitem.
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

ObjectIdName

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

ObjectTypeCode

Property Value
Description Select the type of the queue item, such as activity, case, or appointment.
DisplayName Type
IsValidForForm True
IsValidForRead True
LogicalName objecttypecode
RequiredLevel None
Type Picklist

ObjectTypeCode Choices/Options

Value Label Description
112 Case Service request case associated with a contract.
4200 Activity Task performed, or to be performed, by a user. An activity is any action for which an entry can be made on a calendar.
4201 Appointment Commitment representing a time interval with start/end times and duration.
4202 Email Activity that is delivered using email protocols.
4204 Fax Activity that tracks call outcome and number of pages for a fax and optionally stores an electronic copy of the document.
4207 Letter Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter.
4210 Phone Call Activity to track a telephone call.
4212 Task Generic activity representing work needed to be done.
4214 Service Activity Activity offered by the organization to satisfy its customer's needs. Each service activity includes date, time, duration, and required resources.
4216 Social Activity For internal use only.
4251 Recurring Appointment The Master appointment of a recurring appointment series.
4401 Campaign Response Response from an existing or a potential new customer for a campaign.
4402 Campaign Activity Task performed, or to be performed, by a user for planning or running a campaign.
4406 Quick Campaign System operation used to perform lengthy and asynchronous operations on large data sets, such as distributing a campaign activity or quick campaign.
9953 Knowledge Article Organizational knowledge for internal and external use.

OrganizationId

Property Value
Description Unique identifier of the organization with which the queue item is associated.
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

OwnerId

Property Value
Description Unique identifier of the user or team who owns the queue item.
DisplayName Owner
IsValidForForm False
IsValidForRead True
LogicalName ownerid
RequiredLevel ApplicationRequired
Targets systemuser,team
Type Owner

OwnerIdType

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

OwningBusinessUnit

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

OwningUser

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

QueueIdName

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

Title

Property Value
Description Shows the title or name that describes the queue record. This value is copied from the record that was assigned to the queue.
DisplayName Title
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName title
MaxLength 300
RequiredLevel None
Type String

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

WorkerIdModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the queue item was last assigned to a user.
DisplayName Worked On
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName workeridmodifiedon
RequiredLevel None
Type DateTime

WorkerIdName

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

WorkerIdYomiName

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

One-To-Many Relationships

Listed by SchemaName.

QueueItem_AsyncOperations

Same as the QueueItem_AsyncOperations many-to-one relationship for the asyncoperation entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName QueueItem_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

QueueItem_SyncErrors

Same as the QueueItem_SyncErrors many-to-one relationship for the syncerror entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName QueueItem_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

QueueItem_BulkDeleteFailures

Same as the QueueItem_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName QueueItem_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

queueitem_principalobjectattributeaccess

Same as the queueitem_principalobjectattributeaccess many-to-one relationship for the principalobjectattributeaccess entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName queueitem_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

QueueItem_ProcessSessions

Same as the QueueItem_ProcessSessions many-to-one relationship for the processsession entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName QueueItem_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

knowledgearticle_QueueItems

See the knowledgearticle_QueueItems one-to-many relationship for the knowledgearticle entity.

CampaignActivity_QueueItem

Added by: Marketing Solution

See the CampaignActivity_QueueItem one-to-many relationship for the campaignactivity entity.

CampaignResponse_QueueItem

Added by: Marketing Solution

See the CampaignResponse_QueueItem one-to-many relationship for the campaignresponse entity.

BulkOperation_QueueItem

Added by: Marketing Solution

See the BulkOperation_QueueItem one-to-many relationship for the bulkoperation entity.

Incident_QueueItem

Added by: Service Solution

See the Incident_QueueItem one-to-many relationship for the incident entity.

ServiceAppointment_QueueItem

Added by: Service Solution

See the ServiceAppointment_QueueItem one-to-many relationship for the serviceappointment entity.

lk_queueitem_createdonbehalfby

See the lk_queueitem_createdonbehalfby one-to-many relationship for the systemuser entity.

lk_queueitembase_workerid

See the lk_queueitembase_workerid one-to-many relationship for the systemuser entity.

ActivityPointer_QueueItem

See the ActivityPointer_QueueItem one-to-many relationship for the activitypointer entity.

queue_entries

See the queue_entries one-to-many relationship for the queue entity.

lk_queueitembase_createdby

See the lk_queueitembase_createdby one-to-many relationship for the systemuser entity.

organization_queueitems

See the organization_queueitems one-to-many relationship for the organization entity.

TransactionCurrency_QueueItem

See the TransactionCurrency_QueueItem one-to-many relationship for the transactioncurrency entity.

Appointment_QueueItem

See the Appointment_QueueItem one-to-many relationship for the appointment entity.

Fax_QueueItem

See the Fax_QueueItem one-to-many relationship for the fax entity.

team_queueitembase_workerid

See the team_queueitembase_workerid one-to-many relationship for the team entity.

Email_QueueItem

See the Email_QueueItem one-to-many relationship for the email entity.

SocialActivity_QueueItem

See the SocialActivity_QueueItem one-to-many relationship for the socialactivity entity.

lk_queueitem_modifiedonbehalfby

See the lk_queueitem_modifiedonbehalfby one-to-many relationship for the systemuser entity.

PhoneCall_QueueItem

See the PhoneCall_QueueItem one-to-many relationship for the phonecall entity.

Task_QueueItem

See the Task_QueueItem one-to-many relationship for the task entity.

RecurringAppointmentMaster_QueueItem

See the RecurringAppointmentMaster_QueueItem one-to-many relationship for the recurringappointmentmaster entity.

Letter_QueueItem

See the Letter_QueueItem one-to-many relationship for the letter entity.

lk_queueitembase_modifiedby

See the lk_queueitembase_modifiedby one-to-many relationship for the systemuser entity.

See also

About the Entity Reference
Web API EntityType Reference