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

ServiceAppointmentStatus

Represents a possible status of a service appointment in field service.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Field Service must be enabled.

Fields

Field Name Details
ApiName
Type
string
Properties
Filter, Group, idLookup, Sort
Description
The API name of the status value.
IsDefault
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates that the status value is the default status on service appointments. Only one status value can be the default.
MasterLabel
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The label for the picklist value that appears in the UI.
SortOrder
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The value’s position in the drop-down list of values in the UI.
StatusCode
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The status category that the value corresponds to. The Status Category field has seven values which are identical to the default Status values.

Usage

The Status field on service appointments comes with the following values:
  • None—Default value.
  • Scheduled—Appointment has been assigned to a service resource.
  • Dispatched—Assigned service resource has been notified about their assignment.
  • In Progress—Work has begun.
  • Completed—Work is complete.
  • Cannot Complete—Work could not be completed.
  • Canceled—Work is canceled, typically before any work began
  • CheckedIn—The customer has arrived for their scheduled appointment.

While you can set the status to null via the API, setting the status to null returns an error. To prevent errors, use one of the documented picklist values.

Important

The ServiceAppointmentStatus object corresponds to the Status field. Adding a value to the Status field—for example, Waiting—creates a service appointment status record, and vice versa.

Service appointments also come with a StatusCategory field whose values are identical to the default Status values. If you create custom Status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, you may decide that it belongs in the Cannot Complete category. To learn which processes reference StatusCategory, see How are Status Categories Used?

Note