{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects"
  ],
  "title": "WorkforceCapacity - Data API",
  "description": "Represents the time series for actual or forecasted workforce allocation. This object is available in API version 51.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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"
    }
  },
  "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.\n\nThe org must have the Workforce Engagement\n         license. To view, create, edit, and delete records, the user must have the Workforce\n         Engagement Analyst permission set.",
  "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- **WorkforceCapacityOwnerSharingRule**: Sharing rules are available for the object.\n- **WorkforceCapacityShare**: Sharing is available for the object."
}