Shift

Represents a shift for service resource scheduling.

Introduced in API version 46.0.

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

  • Field Service, Service Engagement, or Workforce Engagement must be enabled. For Field Service, users must have Field Service permissions. For Service Engagement, users must have the Service Engagement Planner permission set. For Workforce Engagement, users must have the Workforce Engagement Admin or Planner permission set.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 61.0

  • Relationship name: AppointmentCategory

  • Relationship type: relationship

  • Refers to: AppointmentCategory

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 54.0
  • Description: Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF.
  • Type: double
  • Properties: Create, Update
  • Type: double
  • Properties: Create, Update
  • Type: datetime
  • Properties: Create, Filter, Sort, Update
  • Description: The date and time that the shift ends.
  • Type: string
  • Properties: Nillable
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 54.0
  • Description: Indicates a shift that overlaps with holiday hours. The default value is false.
  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 53.0

  • Description:

    Indicates whether the shift is nonstandard, such as overtime or on-call shifts.

    The default value is false.

  • Default value: false

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 47.0
  • Description: The job profile associated with the shift.
  • Relationship name: JobProfile
  • Relationship type: relationship
  • Refers to: JobProfile
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The label that a shift is given.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 49.0

  • Description:

    The ID of the recordset filter criteria selected for the shift.

    This is a relationship field.

  • Relationship name: RecordsetFilterCriteria

  • Relationship type: relationship

  • Refers to: RecordsetFilterCriteria

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 68.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 65.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 47.0

  • Description:

    The ID of the service resource the shift belongs to.

    This is a relationship field.

  • Relationship name: ServiceResource

  • Relationship type: relationship

  • Refers to: ServiceResource

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 47.0

  • Description:

    The ID of the service territory the shift belongs to.

    This is a relationship field.

  • Relationship name: ServiceTerritory

  • Relationship type: relationship

  • Refers to: ServiceTerritory

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The number automatically given to the shift upon creation.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 53.0

  • Description:

    The shift template ID, if the shift was created from a shift template.

    This is a relationship field.

  • Relationship name: ShiftTemplate

  • Relationship type: relationship

  • Refers to: ShiftTemplate

  • Type: double
  • Properties: Create, Update
  • Type: double
  • Properties: Create, Update
  • Type: datetime
  • Properties: Create, Filter, Sort, Update
  • Description: The date and time that the shift starts.
  • Type: string
  • Properties: Nillable
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Describes the status of the shift. Users can create custom values. Default values are:
  • Possible values:
    • Tentative — Tentative
    • Published — Published
    • Confirmed — Confirmed
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Describes the status of the shift using static values. This field is derived from Status using the mapping defined in setup.
  • Possible values:
    • Tentative — Tentative
    • Published — Published
    • Confirmed — Confirmed
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Type of time slot for the shift. The same setup values as the TimeSlot field in the OperatingHours object.
  • Possible values:
    • Normal — Normal
    • Extended — Extended
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 56.0

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 68.0

  • Relationship name: WorkforceCapacityPlan

  • Relationship type: relationship

  • Refers to: WorkforceCapacityPlan

Scheduling and dispatching service resources using shift data is not supported in API version 46.0, and is a pilot feature in API version 47.0.

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.