--- schema_version: "1" id: e9e2d75d9163174ce4a37df7448dcf73a5ffb0957de91da5c8521752cf24d43e title: WorkCapacityLimit collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_workcapacitylimit.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workcapacitylimit.htm source_site: developer.salesforce.com content_type: documentation content_hash: faa8a418e054407f0b676a27e2c1223324fb23ee8662a2f86016a3f83b8a00ed description: Represents the capacity limit in a specific service territory for a workstream or for the whole service territory in a given period. This object is available in API version 59.0 and later. --- # WorkCapacityLimit Represents the capacity limit in a specific service territory for a workstream or for the whole service territory in a given period. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields | Field | Details | | --- | --- | | CapacityLimitRelaxation | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Defines the relaxation behavior that determines the limit override policy for this limit if the limit override policy is set per limit in Field Service Settings. If the limit override policy isn’t set per limit, this value is ignored. Valid strings are: - Empty value - no limit override - 0 - limit override starts at midnight on the day of service - Positive integer - limit override starts this number of hours after midnight. the maximum value is 23. - Negative integer - limit override starts this number of hours before midnight. The maximum value is 336. | | Description | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the work capacity limit. | | EndDate | Type date Properties Create, Filter, Group, Nillable, Sort, Update Description End date of the work capacity limit. If no EndDate is set this work capacity limit is without an expiration date. | | IsActive | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the work capacity limit is active or inactive. When creating a record, save the record, and then activate it. You can't update fields in an active record. The default value is false. | | IsFriday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Fridays. The default value is false. | | IsMonday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Mondays. The default value is false. | | IsSaturday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Saturdays. The default value is false. | | IsSunday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Sundays. The default value is false. | | IsSvcTerrOnlyLimit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Apply this work capacity limit to the entire service territory. The default value is false. | | IsThursday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Thursdays. The default value is false. | | IsTuesday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Tuesdays. The default value is false. | | IsWednesday | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the limitation is applied on Wednesdays. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. | | LimitationUnits | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Unit of the LimitationValue. Possible values are: - Hours - Percentage The default value is Hours. | | LimitationValue | Type double Properties Create, Filter, Sort, Update Description If the LimitationUnits is Hours, LimitationValue is the threshold that represents how many hours of total work capacity can be scheduled for a specific workstream in a service territory. Enter the number of hours for the daily limitation as a whole number. If the LimitationUnits is Percentage this threshold represents the percentage of the total work capacity that can be scheduled for a specific workstream in a service territory. Enter the percentage for the daily limitation as a whole number. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the creator of the work capacity limit. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | ServiceTerritoryId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the service territory of the work capacity workstream for which the limit is defined. This field is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | StartDate | Type date Properties Create, Filter, Group, Sort, Update Description The start date of the Work Capacity Limit. | | SvcApptField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Work-specific criteria used to define the capacity limit for the workstream. The service appointment field is set for the organization when the first work capacity limit instance is created. Possible values are: - ServiceAppointment.AccountId - ServiceAppointment.ActualDuration—Actual duration (in minutes) - ServiceAppointment.Duration—Duration - ServiceAppointment.DurationInMinutes - ServiceAppointment.FSL\_\_Appointment\_Grade\_\_ce - ServiceAppointment.FSL\_\_Auto\_Schedule\_\_c - ServiceAppointment.FSL\_\_Duration\_In\_Minutes\_\_c—Scheduled duration - ServiceAppointment.FSL\_\_Emergency\_\_c - ServiceAppointment.FSL\_\_GanttColor\_\_c - ServiceAppointment.FSL\_\_GanttLabel\_\_c - ServiceAppointment.FSL\_\_InJeopardyReason\_\_c - ServiceAppointment.FSL\_\_InJeopardy\_\_c - ServiceAppointment.FSL\_\_IsFillInCandidate\_\_c - ServiceAppointment.FSL\_\_IsMultiDay\_\_c - ServiceAppointment.FSL\_\_Last\_Updated\_Epoch\_\_c - ServiceAppointment.FSL\_\_MDS\_Calculated\_length\_\_c—Multiday work calculated length - ServiceAppointment.FSL\_\_Pinned\_\_c - ServiceAppointment.FSL\_\_Prevent\_Geocoding\_For\_Chatter\_Actions\_\_c - ServiceAppointment.FSL\_\_Related\_Service\_\_c - ServiceAppointment.FSL\_\_Same\_Day\_\_c - ServiceAppointment.FSL\_\_Same\_Resource\_\_c - ServiceAppointment.FSL\_\_Schedule\_Mode\_\_c - ServiceAppointment.FSL\_\_Schedule\_over\_lower\_priority\_appointment\_\_c - ServiceAppointment.FSL\_\_Scheduling\_Policy\_Used\_\_c - ServiceAppointment.FSL\_\_Time\_Dependency\_\_c - ServiceAppointment.FSL\_\_UpdatedByOptimization\_\_c - ServiceAppointment.FSL\_\_Use\_Async\_Logic\_\_c - ServiceAppointment.FSL\_\_Virtual\_Service\_For\_Chatter\_Action\_\_c - ServiceAppointment.IsOffsiteAppointment - ServiceAppointment.Subject - ServiceAppointment.WorkTypeId—Work Type ID | | SvcApptFieldValDplyNm | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The workstream display name of SvcApptFieldValue. If SvcApptField is a lookup to a service appointment, SvcApptFieldValue is an ID and the display name describes the value for the user. | | SvcApptFieldValue | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The value of SvcApptField, the work-specific criteria of the capacity limit. | | TimePeriod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Duration for defining the capacity limitation on the workstream in the service territory. Possible values are: - Day The default value is Day. | | WorkCapacityLimitNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Read-only. Auto populated, unique identifying number. | ## 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. [WorkCapacityLimitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. [WorkCapacityLimitFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [WorkCapacityLimitHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [WorkCapacityLimitShare](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.