FSL Apex Namespace

The Field Service (FSL) namespace contains all classes, methods, Visualforce pages, and custom objects within the Field Service managed package. To allow access to namespace elements, assign the FSL custom permission set that’s appropriate for the user’s persona. For example, to allow a user to book appointments, assign the FSL Agent custom permission set.

  • AdvancedGapMatrix Class

    Represents a matrix of service resource IDs and graded time slots. An instance of this class is used only within the context of the results returned by the GradeSlotsService class.

  • AppointmentBookingService Class

    Represents the appointment booking scheduling process in field service. Appointment booking returns the available slots for a service appointment, while considering scheduling policies, work rules, and service objectives. For example, we can schedule an appointment tomorrow between 9 and 11 AM, or next Monday between 4 and 6 PM.

  • AppointmentBookingSlot Class

    Represents a booking slot available for a given service appointment. An instance of this class is part of the results returned by the AppointmentBookingService and GradeSlotsService classes.

  • GradeSlotsService Class

    Represents the results shown in the Candidates quick action. Use the GradeSlotsService class to evaluate all possible slots where a given service appointment can be scheduled.

  • AppointmentInsightsResult Class

    Represents the response returned by the getAppointmentInsights method. AppointmentInsightsResult includes details about why a service appointment can’t be added to the Gantt, including resource availability, blocked slots, and applicable blocking rules.

  • BlockingRule Class

    Represents a global class that holds an array of blocking rules. . BlockingRule is a required parameter for AppointmentInsightsResult, which is the response class for the getAppointmentInsights method of ScheduleService.

  • GroupData Class

    Represents a global class that combines a group policy ID and a list of service territory IDs. GroupData is a required input parameter for FSL.ScheduleJobsApi.getJob.setTerritory.

  • OAAS Class

    Contains all the methods used in the available optimization services, such as global or in-day optimizations, reshuffle operations, and resource schedule optimizations.

  • OAASRequest Class

    Represents the request sent in the OAAS.Optimize() method. This class contains all the details of a global optimization call.

  • PolygonUtils Class

    Represents the result of using the getTerritoryIdByPolygons method to return a service territory record ID using latitude and longitude geolocation values.

  • RecurringAppointmentsManager Class

    Represents the result of using the getRecurringAppointmentSlots method to return a pattern of appointments that recur weekly.

  • RecurringPattern Class

    Represents a global sharing class that is a required parameter for RecurringAppointmentsManager to return a pattern of appointments that recur weekly.

  • RecurringSequence Class

    Represents the result of using the getRecurringAppointmentsSlots method to return a pattern of appointments that recur daily, weekly, or monthly.

  • ResourceScheduleData Class

    Contains all the details of a service resource’s available slots for a given service appointment. An instance of this class is used only within the context of the results returned by the AdvancedGapMatrix class.

  • ScheduleJobsApi Class

    Represents configurations to the Territory tab that is available for all scheduled jobs that are categorized under Enhanced Optimization.

  • ScheduleResult Class

    Represents the result of scheduling a service appointment that is returned by the ScheduleService.schedule method.

  • ScheduleService Class

    Represents the scheduling of a given service appointment in the best available slot based on the applied scheduling policy.

  • SchedulingOption Class

    Provides the details of an individual slot available for scheduling. Represents a run-time object used within the context of the results returned in the AdvancedGapMatrix class.

  • TimeInterval Class

    Holds an interval’s start and end times. An instance of this class is used when capturing the start and end times of a scheduling horizon, during which a scheduling process runs. It considers scheduled jobs and is also used to represent the start and end times of an appointment slot or window.