Work Queue (workqueue) table/entity reference

Messages

The following table lists the messages for the Work Queue (workqueue) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Assign
Event: True
PATCH /workqueues(workqueueid)
Update the ownerid property.
AssignRequest
ClearWorkQueue
Event: False
ClearWorkQueue Learn to use messages with the SDK for .NET
Create
Event: True
POST /workqueues
See Create
Create records
CreateMultiple
Event: True
CreateMultiple CreateMultipleRequest
Delete
Event: True
DELETE /workqueues(workqueueid)
See Delete
Delete records
Dequeue
Event: False
Dequeue Learn to use messages with the SDK for .NET
GrantAccess
Event: True
GrantAccess GrantAccessRequest
IsValidStateTransition
Event: False
IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess
Event: True
ModifyAccess ModifyAccessRequest
Retrieve
Event: True
GET /workqueues(workqueueid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /workqueues
See Query data
Query data
RetrievePrincipalAccess
Event: True
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True
RevokeAccess RevokeAccessRequest
SetState
Event: True
PATCH /workqueues(workqueueid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /workqueues(workqueueid)
See Update
Update records
UpdateMultiple
Event: True
UpdateMultiple UpdateMultipleRequest
Upsert
Event: False
PATCH /workqueues(workqueueid)
See Upsert a table row
UpsertRequest
UpsertMultiple
Event: False
UpsertMultiple UpsertMultipleRequest

Properties

The following table lists selected properties for the Work Queue (workqueue) table.

Property Value
DisplayName Work Queue
DisplayCollectionName Work Queues
SchemaName workqueue
CollectionSchemaName workqueues
EntitySetName workqueues
LogicalName workqueue
LogicalCollectionName workqueues
PrimaryIdAttribute workqueueid
PrimaryNameAttribute name
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

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

defaultitemtimetoliveinminutes

Property Value
Description The default lifespan in minutes of work queue items when added to the work queue.
DisplayName Default Item Time To Live In Minutes
IsValidForForm True
IsValidForRead True
LogicalName defaultitemtimetoliveinminutes
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

description

Property Value
Description The work queue description.
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

inputschema

Property Value
Description The input schema field contains the expected input schema used for input validation at enqueue time.
DisplayName Input Schema
IsValidForForm True
IsValidForRead True
LogicalName inputschema
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1048576

inputschematype

Property Value
Description The input schema type allows to validate the input field at enqueue time against a specific schema.
DisplayName Input Schema Type
IsValidForForm True
IsValidForRead True
LogicalName inputschematype
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName workqueue_inputschematype

inputschematype Choices/Options

Value Label
0 No Schema
1 Json
2 Xml

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

itemmaxrequeuecount

Property Value
Description The maximum number of times an item can be requeued.
DisplayName Item maximum requeue count
IsValidForForm True
IsValidForRead True
LogicalName itemmaxrequeuecount
RequiredLevel SystemRequired
Type Integer
MaxValue 2147483647
MinValue 0

itemmaxretrycount

Property Value
Description The maximum number of times an item should be retried. This can be overridden at runtime.
DisplayName Item maximum retry count
IsValidForForm True
IsValidForRead True
LogicalName itemmaxretrycount
RequiredLevel SystemRequired
Type Integer
MaxValue 2147483647
MinValue 0

name

Property Value
Description The name of the work queue.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

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

prioritytype

Property Value
Description The priority type determines the pick and processing order for work queue items in a work queue.
DisplayName Priority Type
IsValidForForm True
IsValidForRead True
LogicalName prioritytype
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName workqueue_prioritytype

prioritytype Choices/Options

Value Label
0 Fifo

statecode

Property Value
Description The status of the work queue.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName workqueue_statecode

statecode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: Inactive

statuscode

Property Value
Description Reason for the status of the Work Queue
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName workqueue_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None
3 Label: Paused
State:1
TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

workqueueId

Property Value
Description Unique identifier for entity instances.
DisplayName Work Queue
IsValidForForm False
IsValidForRead True
LogicalName workqueueid
RequiredLevel SystemRequired
Type Uniqueidentifier

workqueuekey

Property Value
Description
DisplayName Work Queue Key
IsValidForForm True
IsValidForRead True
LogicalName workqueuekey
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

WorkQueueType

Property Value
Description The work queue type allows to handle more specific work queue behavior.
DisplayName Work Queue Type
IsValidForForm True
IsValidForRead True
LogicalName workqueuetype
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName workqueue_queuetype

WorkQueueType Choices/Options

Value Label
0 Work Queue
1 Run Queue

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the record was modified.
DisplayName Modified On
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

OwnerIdName

Property Value
Description Name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_workqueue

One-To-Many Relationship: businessunit business_unit_workqueue

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_workqueue_createdby

One-To-Many Relationship: systemuser lk_workqueue_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_workqueue_createdonbehalfby

One-To-Many Relationship: systemuser lk_workqueue_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_workqueue_modifiedby

One-To-Many Relationship: systemuser lk_workqueue_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_workqueue_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_workqueue_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

owner_workqueue

One-To-Many Relationship: owner owner_workqueue

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_workqueue

One-To-Many Relationship: team team_workqueue

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

user_workqueue

One-To-Many Relationship: systemuser user_workqueue

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

flowevent_workqueue

Many-To-One Relationship: flowevent flowevent_workqueue

Property Value
ReferencingEntity flowevent
ReferencingAttribute parentobjectid
ReferencedEntityNavigationPropertyName flowevent_workqueue
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_AsyncOperations

Many-To-One Relationship: asyncoperation workqueue_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName workqueue_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure workqueue_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName workqueue_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord workqueue_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName workqueue_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord workqueue_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName workqueue_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_flowlog_parentobjectid

Many-To-One Relationship: flowlog workqueue_flowlog_parentobjectid

Property Value
ReferencingEntity flowlog
ReferencingAttribute parentobjectid
ReferencedEntityNavigationPropertyName workqueue_flowlog_parentobjectid
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_flowlog_workqueueid

Many-To-One Relationship: flowlog workqueue_flowlog_workqueueid

Property Value
ReferencingEntity flowlog
ReferencingAttribute workqueueid
ReferencedEntityNavigationPropertyName workqueue_flowlog_workqueueid
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder workqueue_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName workqueue_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess workqueue_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName workqueue_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_ProcessSession

Many-To-One Relationship: processsession workqueue_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName workqueue_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_SyncErrors

Many-To-One Relationship: syncerror workqueue_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName workqueue_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

workqueue_workqueueitem

Many-To-One Relationship: workqueueitem workqueue_workqueueitem

Property Value
ReferencingEntity workqueueitem
ReferencingAttribute workqueueid
ReferencedEntityNavigationPropertyName workqueue_workqueueitem
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
workqueue