workqueueitem EntityType
- Entity Set Path
- [organization URI]/api/data/v9.2/workqueueitems
- Base Type
- crmbaseentity
- Display Name
- Work Queue Item
- Primary Key
- workqueueitemid
- Primary Key Attribute
- name
- Operations Supported
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity.Some properties are read-only.
| Name | Type | Details | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| completedon | Edm.DateTimeOffset |
The date and time when the work queue item was completed. Display Name: Completed on |
||||||||||||||||||||
| componentidunique | Edm.Guid |
For internal use only. Display Name: Row id unique Read Only
|
||||||||||||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display Name: Component State Read Only
Default Options
|
||||||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||||||||||||
| delayuntil | Edm.DateTimeOffset |
The date and time after which the work queue item can be dequeued again. Display Name: Delay until |
||||||||||||||||||||
| executioncontext | Edm.String |
The execution context contains a system-managed list of processing attempts, along with important debugging information. Display Name: Execution Context |
||||||||||||||||||||
| expirydate | Edm.DateTimeOffset |
The expiry date indicates the deadline when the work queue items has to be processed by. Display Name: Expiry Date |
||||||||||||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||||||||||||||||
| input | Edm.String |
The input field contains the actual work item data used for processing by bots, humans, or integrations. Display Name: Input |
||||||||||||||||||||
| iscustomizable | BooleanManagedProperty |
For internal use only. Display Name: Is Customizable |
||||||||||||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display Name: Is Managed Read Only
Default Options
|
||||||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display Name: Modified On Read Only
|
||||||||||||||||||||
| name | Edm.String |
The name of the work queue item which is by default set to an auto number (e.g., 2023-02-13-000000001). Display Name: Name |
||||||||||||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display Name: Record Created On |
||||||||||||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display Name: Record Overwrite Time Read Only
|
||||||||||||||||||||
| priority | Edm.Int32 |
The priority value determines the pick and processing order for work queue items in a work queue. A lower value corresponds to a higher priority with 1 being the highest. Display Name: Priority |
||||||||||||||||||||
| processingduration | Edm.Int32 |
The duration of the processing in seconds. Display Name: Processing Duration |
||||||||||||||||||||
| processingresult | Edm.String |
Display Name: Processing Result |
||||||||||||||||||||
| processingstarttime | Edm.DateTimeOffset |
The date and time when the processing has started. Display Name: Processing Start Time |
||||||||||||||||||||
| processorid | Edm.String |
Unique identifier for the processor (workflow, flowmachine, etc.) that processed the item. Display Name: Processor id |
||||||||||||||||||||
| processortype | Edm.Int32 |
The processor type allows to display if the item was processed through a cloud flow, a flow machine or another processor type. Display Name: Processor Type
Default Options
|
||||||||||||||||||||
| requeuecount | Edm.Int32 |
The number of times the item has been requeued. Display Name: Requeue Count |
||||||||||||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||||||||||||
| statecode | Edm.Int32 |
The status of the work queue item (Queued, Processed, Exception etc.) Display Name: Status
Default Options
|
||||||||||||||||||||
| statuscode | Edm.Int32 |
The status reason provides more context for a set status (Queued, Processing, On hold etc.). Display Name: Status Reason
Default Options
|
||||||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||||||||||||
| uniqueidbyqueue | Edm.String |
An identifier of the work queue item used to uniquely identify a work queue item inside a work queue. Display Name: Unique Id By Queue |
||||||||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
||||||||||||||||||||
| versionnumber | Edm.Int64 |
Version Number Display Name: Version Number Read Only
|
||||||||||||||||||||
| workqueueitemid | Edm.Guid |
Unique identifier for entity instances. Display Name: Work Queue Item |
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 Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
| _processinguser_value | processinguser |
Unique identifier for the user that processed the item. |
| _workqueueid_value | workqueueid |
The work queue id of the parent work queue record. |
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 | lk_workqueueitem_createdby |
| createdonbehalfby | systemuser | lk_workqueueitem_createdonbehalfby |
| modifiedby | systemuser | lk_workqueueitem_modifiedby |
| modifiedonbehalfby | systemuser | lk_workqueueitem_modifiedonbehalfby |
| ownerid | principal | owner_workqueueitem |
| owningbusinessunit | businessunit | business_unit_workqueueitem |
| owningteam | team | team_workqueueitem |
| owninguser | systemuser | user_workqueueitem |
| processinguser | systemuser | workqueueitem_processinguser |
| workqueueid | workqueue | workqueue_workqueueitem |
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 |
|---|---|---|
| workqueueitem_AsyncOperations | asyncoperation | regardingobjectid_workqueueitem |
| workqueueitem_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_workqueueitem |
| workqueueitem_DuplicateBaseRecord | duplicaterecord | baserecordid_workqueueitem |
| workqueueitem_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_workqueueitem |
| workqueueitem_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_workqueueitem |
| workqueueitem_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_workqueueitem |
| workqueueitem_ProcessSession | processsession | regardingobjectid_workqueueitem |
| workqueueitem_SyncErrors | syncerror | regardingobjectid_workqueueitem |
Operations
The following operations can be used with the workqueueitem entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |