afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/WorkCapacityUsage.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "WorkCapacityUsage - Data API",
  "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.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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.\n\n- **WorkCapacityUsageFeed**: Feed tracking is available for the object.\n- **WorkCapacityUsageShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n<complexType name=\"WorkCapacityUsage\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"AvailCapacityHours\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"CapacityLimitRelaxation\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ConsumptionToLimitRatio\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"EndDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsSvcTerrOnlyLimit\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LimitationPercentage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"LimitationUnits\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LimitationValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"OriginalLimit\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ServiceTerritory\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ServiceTerritory\"/>\n        <element name=\"ServiceTerritoryId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"StartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n        <element name=\"SvcApptField\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SvcApptFieldValDplyNm\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SvcApptFieldValue\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TimeConsumedInHours\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"TimeConsumedInMinutes\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"TimePeriod\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"TopicAssignments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n        <element name=\"WcuUniqueField1\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"WcuUniqueField2\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"WorkCapacityUsageNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "AvailCapacityHours": {
      "field_label": "Available Capacity (in hours)",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "CapacityLimitRelaxation": {
      "field_label": "Limit Override Policy",
      "type": "string",
      "length": "255"
    },
    "ConsumptionToLimitRatio": {
      "field_label": "Consumption to Limit Ratio (%)",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "EndDate": {
      "field_label": "End Date",
      "type": "date"
    },
    "Id": {
      "field_label": "Work Capacity Usage ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsSvcTerrOnlyLimit": {
      "field_label": "Service Territory Limit",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "LimitationPercentage": {
      "field_label": "Limitation (in percentage)",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "LimitationUnits": {
      "field_label": "Limitation Units",
      "type": "picklist",
      "length": "255"
    },
    "LimitationValue": {
      "field_label": "Limitation (in hours)",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "OriginalLimit": {
      "field_label": "Original Limitation",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "ServiceTerritoryId": {
      "field_label": "Territory ID",
      "type": "reference",
      "length": "18"
    },
    "StartDate": {
      "field_label": "Start Date",
      "type": "date"
    },
    "SvcApptField": {
      "field_label": "Service Appointment Field",
      "type": "picklist",
      "length": "255"
    },
    "SvcApptFieldValDplyNm": {
      "field_label": "Field Value Display Name",
      "type": "string",
      "length": "255"
    },
    "SvcApptFieldValue": {
      "field_label": "Field Value",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TimeConsumedInHours": {
      "field_label": "Time Consumed (in hours)",
      "type": "double",
      "precision": "18",
      "scale": "0"
    },
    "TimeConsumedInMinutes": {
      "field_label": "Time Consumed (in minutes)",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "TimePeriod": {
      "field_label": "Time Period",
      "type": "picklist",
      "length": "255"
    },
    "WcuUniqueField1": {
      "field_label": "Wcu Unique Field1",
      "type": "string",
      "length": "255"
    },
    "WcuUniqueField2": {
      "field_label": "Wcu Unique Field2",
      "type": "string",
      "length": "255"
    },
    "WorkCapacityUsageNumber": {
      "field_label": "Usage Number",
      "type": "string",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length"
  ]
}