WorkCapacityLimit

Represents a time-based threshold for a specific work type group, service territory, and date range in Field Service Lightning. This object is available in API version 46.0 and later.

Supported Calls

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

Special Access Rules

Field Service Lightning must be enabled.

For the Summer ’19 release, work capacity limits serve only as a suggestion, not a rule. Dispatchers can refer to the limits for guidance on how to structure the schedule. However, Field Service Lightning’s scheduling and optimization features don’t enforce the limits you create. Work capacity usage records also don’t update to reflect scheduled work, and there’s no way to review the appointments that count against each limit.

Important

Fields

Field Name	Details
EndDate	Type date Properties Create, Filter, Group, Sort Description The end date of the period in which the limit applies. If the time period is a week, select either Saturday (if the start date is Sunday) or Sunday (if the start date is Monday). If the time period is a month, select the month’s last calendar date, such as 30.
HoursPerTimePeriod	Type double Properties Create, Filter, Sort, Update Description The number of hours of work that can be completed per day, week, or month. For example, if the time period is a week, enter 20 to allot up to 20 hours of service appointments per week for the selected work type group in the selected service territory, between the start and end dates.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Whether this limit is currently active. Only active work capacity limits are enforced. Because you can’t change a limit’s start and end dates after the limit is created, deactivating (and optionally, replacing) the work capacity limit is a way to remove it from your scheduling logic.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last viewed by the current user.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the work capacity limit.
ServiceTerritoryId	Type reference Properties Create, Filter, Group, Sort Description The service territory that the limit applies to.
StartDate	Type date Properties Create, Filter, Group, Sort Description The start date of the period in which the limit applies. If the time period is a week, select Sunday or Monday. If the time period is a month, select the first calendar day of a month.
TimePeriod	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The time period that the limit applies to. Possible values are: `Day` `Week` `Month`
WorkCapacityLimitNumber	Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Autogenerated number identifying the work capacity limit. It uses the format WCL-####.
WorkCapacityUsageStatus	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The status of the latest changes to the work capacity limit’s related capacity usage records. The values are: Creation Complete Creation In Progress Creation Failed Update Complete Update Failed Update In Progress A work capacity limit record can’t be activated until its related work capacity usage records are created.
WorkTypeGroupId	Type reference Properties Create, Filter, Group, Sort Description The work type group that the limit applies to.

Object Reference for Salesforce and Lightning Platform

WorkCapacityLimit

Supported Calls

Special Access Rules

Fields