WorkforceCapacity

Represents the time series for actual or forecasted workforce allocation. This object is available in API version 51.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, and 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 planning.
EndDateTime	Type dateTime Properties Create, Filter, Sort, Update Description The end date and time of the planning.
IsOmni	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Derived from isOmni field on Workload object. Indicates that the workload is Omni-based. If workload is null, the field value defaults to `false`. The default value is `false`.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the plan.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the record. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PlanType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The type of capacity plan. Possible values are: `Intraday`—The plan shows intraday management. `LongTerm`—The plan predicts the required number of full-time employees (FTEs). `ShortTerm`—The plan predicts the required number of shifts. This field is available in API version 54.0 and later.
StartDateTime	Type dateTime Properties Create, Filter, Sort, Update Description The start date and time of the planning.
TimeZone	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The time zone associated with the capacity plan. Possible values are the time zones supported by Workforce Engagement. This field is available in API version 56.0 and later.
WorkloadId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The foreign key to the Workload object. This is a relationship field. Relationship Name Workload Relationship Type Lookup Refers To Workload

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.

WorkforceCapacityOwnerSharingRule: Sharing rules are available for the object.
WorkforceCapacityShare: Sharing is available for the object.

Object Reference for the Salesforce Platform

WorkforceCapacity

Supported Calls

Special Access Rules

Fields

Associated Objects