---
schema_version: "1"
id: 9bc8534437df865c898df3d43d867fab1d236d65e61b12fae5eca319121f777b
title: Workload
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_workload.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workload.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: cfceaf0480beac5009c411b53c828700edbdbdd5c61cdea052565dc1fcc7f201
description: Represents the time series for work item volume and average handle time from aggregation and forecasting processes. This object is available in API version 49.0 and later.
---
# Workload

Represents the time series for work item volume and average handle time from aggregation and forecasting processes. 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 the Workforce Engagement license. To view, create, edit, or delete records, the user must have the Workforce Engagement Analyst permission set.

## Fields

| Field | Details |
| --- | --- |
| Description | 
Type

textarea

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Additional information about the workload



 |
| EndDateTime | 

Type

dateTime

Properties

Create, Filter, Sort

Description

The end date and time of the time series represented by the Workload object.



 |
| IsOmni | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort

Description

Indicates that the workload is Omni-based.

The default value is 'false'.



 |
| Name | 

Type

string

Properties

Create, Filter, Group, idLookup, Sort, Update

Description

The workload name.



 |
| OwnerId | 

Type

reference

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

The owner of the workload.

This is a polymorphic relationship field.

Relationship Name

Owner

Relationship Type

Lookup

Refers To

Group, User



 |
| StartDateTime | 

Type

dateTime

Properties

Create, Filter, Sort

Description

The start date and time of the time series represented by the Workload object.



 |
| TimeZone | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort

Description

The time zone associated with the workload. Possible values are the time zones supported by Workforce Engagement.

This field is available in API version 56.0 and later.



 |
| WorkloadType | 

Type

picklist

Properties

Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

Description

The type of the workload.

Possible values are:

- F—Forecasted
- H—Historical
- IH—Intraday History. This value is available in API version 55.0 and later.

The default value is 'H'.



 |

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[WorkloadOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")

Sharing rules are available for the object.

[WorkloadShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.