Field Service Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Field Service Developer Guide
Get Ready to Develop with Field Service
API End-of-Life Policy
Field Service Data Objects
Field Service Core Data Model
Field Service Inventory Management Data Model
Field Service Preventive Maintenance Data Model
Field Service Product Service Campaign Data Model
Field Service Warranty Management Data Model
Field Service Pricing Data Model
Field Service Object References
Field Service Standard and Custom Objects
Address
ApptBundleAggrDurDnscale
ApptBundleAggrPolicy
ApptBundleConfig
ApptBundlePolicy
ApptBundlePolicySvcTerr
ApptBundlePropagatePolicy
ApptBundleRestrictPolicy
ApptBundleSortPolicy
AppExtension
Asset
AssetAccountParticipant
AssetAttribute
AssetContactParticipant
AssetDowntimePeriod
AssetRelationship
AssetWarranty
AssignedResource
AssociatedLocation
AttributeDefinition
AttributePicklist
AttributePicklistValue
ContractLineItem
ContractLineOutcome
ContractLineOutcomeData
DigitalSignature
Entitlement
EntityMilestone
Expense
ExpenseReport
ExpenseReportEntry
FieldServiceMobileSettings
FldSvcObjChg
FldSvcObjChgDtl
FSL__Time_Dependency__c
GeolocationBasedAction
LinkedArticle
Location
MaintenanceAsset
MaintenancePlan
MaintenanceWorkRule
MobileSettingsAssignment
OperatingHours
OperatingHoursHoliday
Pricebook2
Product2
ProductConsumed
ProductConsumedState
ProductItem
ProductItemTransaction
ProductRequest
ProductRequestLineItem
ProductRequired
ProductServiceCampaign
ProductServiceCampaignItem
ProductServiceCampaignItemStatus
ProductServiceCampaignStatus
ProductTransfer
ProductWarrantyTerm
RecordsetFilterCriteria
RecordsetFilterCriteriaRule
RecordsetFltrCritMonitor
ResourceAbsence
ResourcePreference
ReturnOrder
ReturnOrderLineItem
SerializedProduct
SerializedProductTransaction
ServiceAppointment
ServiceAppointmentStatus
ServiceContract
ServiceCrew
ServiceCrewMember
ServiceReport
ServiceReportLayout
ServiceResource
ServiceResourceCapacity
ServiceResourceSkill
ServiceTerritory
ServiceTerritoryLocation
ServiceTerritoryMember
Shift
ShiftPattern
ShiftPatternEntry
ShiftTemplate
Shipment
Skill
SkillRequirement
TimeSheet
TimeSheetEntry
TimeSlot
TravelMode
WarrantyTerm
WorkCapacityAvailability
WorkCapacityLimit
WorkCapacityUsage
WorkOrder
WorkOrderLineItem
WorkOrderLineItemStatus
WorkPlan
WorkPlanSelectionRule
WorkPlanTemplate
WorkPlanTemplateEntry
WorkOrderStatus
WorkStep
WorkStepStatus
WorkStepTemplate
WorkType
WorkTypeGroup
WorkTypeGroupMember
Field Service Custom Fields on Standard Objects
Supplementary Field Service Objects
Field Service REST API
Field Service Metadata API
Field Service Tooling API
Field Service Apex Namespace
Field Service Custom Triggers
Field Service Code Examples
Field Service Mobile App
PDF

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, the user needs to have a Workforce Engagement Admin or Planner permission set.

Fields

Field Details
BackgroundColor
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. Available in API version 54.0 and later.
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.
IsNonStandard
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the shift is nonstandard, such as overtime or on-call shifts.
The default value is false. Available in API version 54.0 and later.
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
RecordsetFilterCriteriaId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the recordset filter criteria selected for the shift template. Available in API version 53.0 and later.
This is a relationship field.
Relationship Name
RecordsetFilterCriteria
Relationship Type
Lookup
Refers To
RecordsetFilterCriteria
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.
TimeSlotType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of time slot. Possible values are:
  • Normal
  • Extended
You can use Extended to represent overtime shifts. Available in API version 55.0 and later.

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.
ShiftTemplateChangeEvent
Change Data Capture events are available for the object. Available in API version 54.0 and later.