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

{
  "sections": [
    "title",
    "description",
    "fields",
    "field_reference"
  ],
  "title": "AppointmentSchedulingPolicy - Data API",
  "description": "Represents a set of rules for scheduling appointments using Salesforce Scheduler. This object is available in API version 45.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AppointmentAssignmentPolicyId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The name or ID of the appointment assignment policy. This is a relationship field, available in version 52.0 and later.",
      "relationship_name": "AppointmentAssignmentPolicy",
      "relationship_type": "Lookup",
      "refers_to": "AppointmentAssignmentPolicy"
    },
    "AppointmentStartTimeInterval": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The proposed time interval in minutes between appointment start times. For example, set the interval to 15. Appointments can then begin at the top of the hour and at 15-minute intervals thereafter (10:00 AM, 10:15 AM, 10:30 AM, and so on). Possible values are: 5 10 15 20 30 45 60 90 120 150 180 240 300 360 420 480"
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The API name of the AppointmentSchedulingPolicy object."
    },
    "ExtCalEventHandlerId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The API name of the custom Apex class that checks service resources’ external calendar events and returns the time slots where service resources are already booked. Available in API version 50.0 and later. This is a relationship field.",
      "relationship_name": "ExtCalEventHandler",
      "relationship_type": "Lookup",
      "refers_to": "ApexClass"
    },
    "IsOrgDefault": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether this scheduling policy is the default appointment scheduling policy for Lightning Scheduler appointments in this org."
    },
    "IsSvcTerrOpHoursWithShiftsUsed": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this scheduling policy considers the intersection of shifts and service territory operating hours when determining the availability of service resources for appointments (true). The default value is false. Available in API version 56.0 and later."
    },
    "IsSvcTerritoryMemberShiftUsed": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this scheduling policy considers shifts of service territory members when determining the availability of service resources for appointments (true). The default value is false. Available in API version 56.0 and later."
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The language of the appointment scheduling policy. Possible values are: Possible values are: da (Danish) de (German) en_US (English) es (Spanish) es_MX (Spanish - Mexican) fi (Finnish) fr (French) it (Italian) ja (Japanese) ko (Korean) nl_NL (Dutch) no (Norwegian) pt_BR (Portuguese - Brazilian) ru (Russian) sv (Swedish) th (Thai) zh_CN (Chinese - Simplified) zh_TW (Chinese - Traditional)"
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The label for the appointment scheduling policy."
    },
    "ShouldConsiderCalendarEvents": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this policy checks the Salesforce calendar for resource availability. The default value is 'false'."
    },
    "ShouldEnforceExcludedResource": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy prevents excluded service resources from being assigned to appointments."
    },
    "ShouldEnforceRequiredResource": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy allows only required service resources to be assigned to appointments."
    },
    "ShouldMatchSkill": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy allows only required service resources who have certain skills to be assigned to appointments."
    },
    "ShouldMatchSkillLevel": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy allows only required service resources who have certain skills and skill levels to be assigned to appointments."
    },
    "ShouldRespectVisitingHours": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy prevents users from scheduling appointments outside of an account’s visiting hours."
    },
    "ShouldUsePrimaryMembers": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy allows only service resources who are primary members of a service territory to be assigned to appointments."
    },
    "ShouldUseSecondaryMembers": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether this appointment scheduling policy allows service resources who are secondary members of a service territory to be assigned to appointments."
    }
  },
  "field_reference": {
    "AppointmentStartTimeInterval": {
      "field_label": "Appointment Start Time Interval",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DeveloperName": {
      "field_label": "Developer Name",
      "type": "string",
      "length": "80"
    },
    "ExtCalEventHandlerId": {
      "field_label": "Class ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Appointment Scheduling Policy ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsOrgDefault": {
      "field_label": "Is Default",
      "type": "boolean"
    },
    "IsSvcTerrOpHoursWithShiftsUsed": {
      "field_label": "Use service territory’s operating hours with shifts",
      "type": "boolean"
    },
    "IsSvcTerritoryMemberShiftUsed": {
      "field_label": "Use service territory member’s shift",
      "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": "80"
    },
    "ShouldConsiderCalendarEvents": {
      "field_label": "Check Salesforce Calendar for Resource Availability",
      "type": "boolean"
    },
    "ShouldEnforceExcludedResource": {
      "field_label": "Ignore Excluded Service Resources",
      "type": "boolean"
    },
    "ShouldEnforceRequiredResource": {
      "field_label": "Include Only Required Service Resources",
      "type": "boolean"
    },
    "ShouldMatchSkill": {
      "field_label": "Match Skills",
      "type": "boolean"
    },
    "ShouldMatchSkillLevel": {
      "field_label": "Match Skill Levels",
      "type": "boolean"
    },
    "ShouldRespectVisitingHours": {
      "field_label": "Enforce Account's Visiting Hours",
      "type": "boolean"
    },
    "ShouldUsePrimaryMembers": {
      "field_label": "Include Primary Service Territory Members",
      "type": "boolean"
    },
    "ShouldUseSecondaryMembers": {
      "field_label": "Include Secondary Service Territory Members",
      "type": "boolean"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}