ShiftTemplate

Represents a template for creating shifts. This object is available in API version 51.0 and later.

Supported Calls

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

Special Access Rules

Field Service or Workforce Engagement must be enabled. For Field Service, users must have Field Service permission. For Workforce Engagement, to create a shift and apply a template, the user needs to have a Workforce Engagement Planner permission set.

Fields

Field	Details
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the shift like number of breaks or activities.
Duration	Type double Properties Create, Filter, Sort, Update Description How long the shift lasts. The unit of measurement for this field is determined by ShiftTemplateDurationType.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is active or inactive.
JobProfileId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Job Profile record. This field is optional. This is a relationship field. Relationship Name JobProfile Relationship Type Lookup Refers To JobProfile
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the shift template was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the shift template was last viewed.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The shift template record name.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shift template. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
ShiftTemplateDurationType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The unit of measurement for the shift template duration. Possible values are: `H`—Hours `M`—Minutes The default value is `H`.
StartTime	Type time Properties Create, Filter, Sort, Update Description The time of day when the shift starts.

Associated Objects

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 and later.

ShiftTemplateOwnerSharingRule: Sharing rules are available for the object.
ShiftTemplateShare: Sharing is available for the object.

Field Service Developer Guide

ShiftTemplate

Supported Calls

Special Access Rules

Fields

Associated Objects