Newer Version Available

This content describes an older version of this product. View Latest

WorkloadUnit

Represents the number of work items and average handle time in a specific time interval. This object is available in API version 49.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

The org must have a Workforce Engagement license. To view, create, edit, and delete records, the user needs to have the Workforce Engagement Analyst permission set.

Fields

Field Details
AverageHandleTime
Type
double
Properties
Filter, Nillable, Sort
Description
The average handle time at a specific period of time.
Channel
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The channel value.
CustomWorkType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The derived field of WorkDemographic.CustomWorkType for the custom dimension value.
DateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The timestamp of the single data point in the time series of the workload.
MeasureUnit
Type
string
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The time interval (in minutes) used in the workload. We currently support 60 (hourly), 1440 (daily), and 10080 (weekly) intervals. The default value is 1440.
Region
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The derived field from WorkDemographic.Region for the region value.
SkillSet
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The derived field from WorkDemographic.SkillSet for the skill value.
TotalCount
Type
int
Properties
Create, Filter, Group, Sort
Description
The total number work items at a specific period of time.
WorkDemographicId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The foreign key to the WorkDemographic object.
This is a relationship field.
Relationship Name
WorkDemographic
Relationship Type
Lookup
Refers To
WorkDemographic
WorkloadId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The foreign key to the Workload object.
This is a relationship field.
Relationship Name
Workload
Relationship Type
Lookup
Refers To
Workload
WorkloadType
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The derived field from Workload.WorkloadType to indicate the type of workload, e.g. history or forecast workload.
Possible values are:
  • F—Forecasted
  • H—Historical
The default value is 'H'.