ServiceAppointment

Represents available shifts for a workplace and confirmed shifts for service resources. Service appointments are linked to planned occupancy and, when confirmed, to a service resource (a person). This object is available in API version 38.0 and later.

For standard fields on the ServiceAppointment object, see Object Reference - ServiceAppointment.

The following Status values are relevant to Shift Management:

  • None—The initial state; the appointment is not linked to a service resource and it represents an available shift.
  • Scheduled—The appointment is linked to a service resource (through the AssignedResource junction object). The appointment represents a shift that is tentatively filled by that service resource.
  • Dispatched—The appointment is now shared with the service resource and the service resource is notified that they are assigned to that shift.
  • In Progress—The service resource accepted the shift.

The service resource can also reject a shift. In that case, the AssignedResource record is deleted and the appointment represents an available shift again.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

FieldTypePropertiesDescription
wkfsl__Facility_Plan__creferenceCreate, Filter, Group, Nillable, Sort, UpdateThe facility plan. This has information such as maximum occupancy information for a location. This field is available in API version 48.0 and later.
wkfsl__Reject_type__cpicklistCreate, Filter, Group, Nillable, Restricted picklist, Sort, UpdateThis field is reserved for future use.