Newer Version Available

This content describes an older version of this product. View Latest

Shift

Represents a shift for service resource scheduling. Available in API versions 46.0 and later.

Supported Calls

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

Special Access Rules

Field Service must be enabled. Users must have Field Service permission.

Fields

Field Details
EndTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time that the shift ends.
JobProfileId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The job profile associated with the shift. Available in API versions 47.0 and later.
Label
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The label that a shift is given.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the current user last viewed a related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the current user last viewed this record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the shift.
ServiceResourceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the service resource the shift belongs to. Available in API versions 47.0 and later.
ServiceTerritoryId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the service territory the shift belongs to. Available in API versions 47.0 and later.
ShiftNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The number automatically given to the shift upon creation.
StartTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time that the shift starts.
Status
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Describes the status of the shift. Users can create custom values. Default values are:
  • Tentative
  • Published
  • Confirmed
StatusCategory
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 are:
  • Tentative
  • Published
  • Confirmed
TimeSlotType
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 are:
  • Normal (default value)
  • Extended

Usage

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.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ShiftFeed
Feed tracking is available for the object.
ShiftHistory
History is available for tracked fields of the object.
ShiftOwnerSharingRule
Sharing rules are available for the object.
ShiftShare
Sharing is available for the object.