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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "SchedulingObjective - Data API",
  "description": "Represents business goals that the scheduling tools consider. This object is available in API version 53.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "The scheduling objective description."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The developer name of the record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Possible values are the supported languages for Workforce Engagement."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The scheduling objective name."
    },
    "SchedulingCategory": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The record that the scheduling objective applies to. Possible values are: A—Appointment B—Shift"
    },
    "SchedulingObjectiveType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The type of scheduling objective. Possible values are: AgentPreference—Scheduling tools consider agents’ service resource preferences. In the UI, this value appears as Maximized Preferences. BalanceNonStandardShifts—Scheduling tools balance the number of shifts across available agents within a time period. BalanceShifts—Scheduling tools balance the number of non-standard shifts across available agents within a time period."
    }
  },
  "special_access_rules": "The org must have the Workforce Engagement license. To view, create, edit, and delete records, the user needs to have the Workforce Engagement Planner permission set.\n\nThe org must have the Workforce Engagement\n         license. To view, create, edit, and delete records, the user needs to have the Workforce\n         Engagement Planner permission set.",
  "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=\"SchedulingObjective\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Language\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SchedulingCategory\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SchedulingObjectiveParameters\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SchedulingObjectiveType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "500"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "100"
    },
    "Id": {
      "field_label": "Scheduling Objective ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Name",
      "type": "string",
      "length": "100"
    },
    "SchedulingCategory": {
      "field_label": "Objective Category",
      "type": "picklist",
      "length": "255"
    },
    "SchedulingObjectiveType": {
      "field_label": "Objective Type",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}