workqueue EntityType
- Entity Set Path
- [organization URI]/api/data/v9.2/workqueues
- Base Type
- crmbaseentity
- Display Name
- Work Queue
- Primary Key
- workqueueid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
|
||||||||||
| defaultitemtimetoliveinminutes | Edm.Int32 |
The default lifespan in minutes of work queue items when added to the work queue. Display Name: Default Item Time To Live In Minutes |
||||||||||
| description | Edm.String |
The work queue description. Display Name: Description |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||||||
| inputschema | Edm.String |
The input schema field contains the expected input schema used for input validation at enqueue time. Display Name: Input Schema |
||||||||||
| inputschematype | Edm.Int32 |
The input schema type allows to validate the input field at enqueue time against a specific schema. Display Name: Input Schema Type
Default Options
|
||||||||||
| 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
|
||||||||||
| itemmaxrequeuecount | Edm.Int32 |
The maximum number of times an item can be requeued. Display Name: Item maximum requeue count |
||||||||||
| 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. 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
|
||||||||||
| prioritytype | Edm.Int32 |
The priority type determines the pick and processing order for work queue items in a work queue. Display Name: Priority Type
Default Options
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| statecode | Edm.Int32 |
The status of the work queue. Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Work Queue Display Name: Status Reason
Default Options
|
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||
| 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
|
||||||||||
| workqueueid | Edm.Guid |
Unique identifier for entity instances. Display Name: Work Queue |
||||||||||
| workqueuekey | Edm.String |
Display Name: Work Queue Key |
||||||||||
| workqueuetype | Edm.Int32 |
The work queue type allows to handle more specific work queue behavior. Display Name: Work Queue Type
Default Options
|
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. |
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_workqueue_createdby |
| createdonbehalfby | systemuser | lk_workqueue_createdonbehalfby |
| modifiedby | systemuser | lk_workqueue_modifiedby |
| modifiedonbehalfby | systemuser | lk_workqueue_modifiedonbehalfby |
| ownerid | principal | owner_workqueue |
| owningbusinessunit | businessunit | business_unit_workqueue |
| owningteam | team | team_workqueue |
| owninguser | systemuser | user_workqueue |
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 |
|---|---|---|
| workqueue_AsyncOperations | asyncoperation | regardingobjectid_workqueue |
| workqueue_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_workqueue |
| workqueue_DuplicateBaseRecord | duplicaterecord | baserecordid_workqueue |
| workqueue_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_workqueue |
| workqueue_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_workqueue |
| workqueue_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_workqueue |
| workqueue_ProcessSession | processsession | regardingobjectid_workqueue |
| workqueue_SyncErrors | syncerror | regardingobjectid_workqueue |
| workqueue_workqueueitem | workqueueitem | workqueueid |
Operations
The following operations can be used with the workqueue entity type.
| Name | Binding |
|---|---|
| ClearWorkQueue | Bound to Entity |
| CreateMultiple | Not Bound |
| Dequeue | Bound to Entity |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |