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

AssignedResource

Represents a service resource who is assigned to a service appointment in Field Service and Lightning Scheduler. Assigned resources appear in the Assigned Resources related list on service appointments. This object is available in API version 38.0 and later.

Supported Calls

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

Fields

Field Name Details
ActualTravelTime
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of minutes that the service resource needs to travel to the assigned service appointment. You can enter a value with up to two decimal places.
ApptAssistantInfoUrl
Type
textarea
Properties
Create, Nillable, Update
Description
The URL that contains the status of the mobile worker approaching the service appointment, the Community URL, and the expiry of the URL. Available in version 51.0 and later.
AssignedResourceNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An auto-generated number identifying the resource assignment.
EstimatedTravelTime
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The estimated number of minutes needed for the service resource to travel to the service appointment they’re assigned to. You can enter a value with up to two decimal places.
LocationStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the mobile worker approaching the service appointment. When the location status changes to one of these values, a status update containing ApptAssistantInfoUrl is sent to the customer. Available in version 51.0 and later.
Possible values are:
  • EnRoute
  • LastMile
IsPrimaryResource
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the service resource is a primary resource or not. The default value is false. Available in API version 47.0 and later.
ServiceAppointmentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The service appointment that the resource is assigned to.
This is a relationship field.
Relationship Name
ServiceAppointment
Relationship Type
Lookup
Refers To
ServiceAppointment
ServiceCrewId
Type
reference
Properties
Create, Update, Filter, Group, Sort, Nillable
Description
The service crew that the resource is assigned to.

Since service resources can represent crews or individuals, appointments are typically assigned to crews in the following way:

  1. Create a service resource of the Crew type that represent the crew.
  2. Create an assigned resource on the service appointment and select the crew resource in the ServiceResourceId field.

Note
ServiceResourceId
Type
reference
Properties
Create, Update, Filter, Group, Sort
Description
The resource who is assigned to the service appointment.
This is a relationship field.
Relationship Name
ServiceResource
Relationship Type
Lookup
Refers To
ServiceResource
Transaction
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The last transaction ID of the scheduling and optimization request that updated this object. The transaction ID is automatically generated and populated by the Enhanced Scheduling and Optimization engine. Available in API version 63.0 and later.

Usage

You can assign multiple service resources to a service appointment. Service resources who are assigned to service appointments cannot be deactivated until they are removed from the appointments.

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.

AssignedResourceChangeEvent (API version 48.0)
Change events are available for the object.
AssignedResourceHistory(API version 61.0)
History is available for tracked fields of the object.
AssignedResourceFeed
Feed tracking is available for the object.