--- schema_version: "1" id: 713bbb8be90fbf72b307f6890487d4697659ea43da6e38901372b432c0f46149 title: WorkCapacityUsage collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_workcapacityusage.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workcapacityusage.htm source_site: developer.salesforce.com content_type: documentation content_hash: 09306a2f43975b719c1a837bb9c3ebd8505239c22093904e9d8272247455eb62 description: Represents the capacity usage 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. --- # WorkCapacityUsage Represents the capacity usage 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 | | --- | --- | | AvailCapacityHours | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description This value is copied from the AvailCapacityHours of the WorkCapacityAvailability object for the service territory on the same date. | | 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. | | ConsumptionToLimitRatio | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort Description (Time consumed in hours / Limit in hours) \* 100 Note the following exceptions. - If a limit isn’t defined (-1) the ratio is -1 (even if consumption is 0 or higher). - If consumption is 0, and the limit is a number greater than 0, then the ration is 0. - If consumption is 0 and the limit is 0, the ration is 100% hard-coded. - If consumption is greater than 0 and the limit is 0, the ration is calculated as if the limit = 0.99 in order to get a result that’s higher than 100%. | | EndDate | Type date Properties Create, Filter, Group, Sort Description End date of the time period for which the capacity usage is accumulated. | | IsSvcTerrOnlyLimit | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Applies this work capacity limit to the entire service territory. 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. | | LimitationPercentage | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort Description If the LimitationUnits is Percentage this value is copied from the LimitationValue field of the WorkCapacityLimit object. | | LimitationUnits | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Defines whether the limitation for the workstream in the service territory is in hours or as a percentage of all the available hours for all the workstreams for which limitations exist in the service territory on a specific day. Possible values are: - Hours - Percentage The default value is Hours. | | LimitationValue | Type double Properties Create, Filter, Sort Description The LimitationValue depends on the LimitationUnit. If the LimitationUnit is Hours the value is copied from LimitationValue in the WorkCapacityLimit object. If the LimitationUnit is Percentage, the percentage is calculated relative to the availability in the WorkCapacityAvailability object. | | OriginalLimit | Type double Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description If the limit value is changed after the work capacity usage was created, this parameter is the original value. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. 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 Description ID of the service territory of the work capacity workstream for which usage is accumulated. This field is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory | | StartDate | Type date Properties Create, Filter, Group, Sort Description Start date of the time period for which the capacity usage is accumulated. | | SvcApptField | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Work-specific criteria used to define the capacity limit for the workstream. 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 Workstream display name of SvcApptFieldValue. | | SvcApptFieldValue | Type string Properties Create, Filter, Group, Nillable, Sort Description Value of SvcApptField, the work-specific criteria of the capacity limit. | | TimeConsumedInHours | Type double Properties Create, Filter, Nillable, Sort Description Time consumed in hours by the workstream in the service territory for the defined period. This value is calculated by dividing TimeConsumedInMinutes by 60. | | TimeConsumedInMinutes | Type double Properties Create, Filter, Sort Description Time consumed in minutes by the workstream in the service territory for the defined period. | | TimePeriod | Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Duration for defining the capacity limitation on the workstream in the service territory. Possible values are: - Day The default value is Day. | | WcuUniqueField1 | Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Read-only. Auto populated, unique identifying number. | | WcuUniqueField2 | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Read-only. Auto populated, unique identifying number. | | WorkCapacityUsageNumber | 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. [WorkCapacityUsageFeed](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. [WorkCapacityUsageShare](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.