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

RecordsetFilterCriteria

Represents a set of filters that can be used to match service appointments or assets based on your criteria fields. For example, you can create recordset filter criteria so that only service appointments that satisfy the filter criteria are matched to the filtered shifts, and likewise only maintenance work rules that satisfy your criteria are matched to assets. This object is available in API version 50.0 and later. Assets and maintenance work rules are available in API version 52.0 and later.

Supported Calls

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

Special Access Rules

Field Service must be enabled.

Fields

Field Details
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the recordset filter criteria.
FilteredObject
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The object used to define the filter criteria. Available in API version 52.0 or later.
Possible values are:
  • Asset
  • ServiceAppointment
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the recordset filter criteria is associated with shifts or maintenance work rules (true) or not (false).
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the recordset filter criteria was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the recordset filter criteria was last viewed.
LogicalOperator
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Defines the logic to evaluate multiple recordset filter criteria rules. Available in API version 53.0 and later.
Possible values are:
  • AND
  • OR
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the recordset filter criteria.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the recordset filter criteria.
SourceObject
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
The source object that the filtered criteria are applied to. Shifts and maintenance work rules are available in API version 52.0 and later. Appointment bundle objects are available in API version 53.0 and later.
Possible values are:
  • ApptBundleAggrPolicy—Appointment Bundle Aggregation Policy
  • ApptBundleConfig—Appointment Bundle Config
  • Shift
  • ContractLineOutcome
  • MaintenanceWorkRule
Usage Rate Field
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Stores the daily usage rate of the asset. The unit for the usage rate must be per day.
Usage Rate Unit
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Defines the rate for Usage Rate Field.
Possible values are:
  • DAYS

Usage

Let's say an employee is open to working a 9 am to 5 pm shift on a Sunday but only for emergency appointments. In this case, the SourceObject is Shift and the FilteredObject is ServiceAppointment. The service appointments available for that shift are filtered for emergency appointments using the RecordsetFilterCriteriaRule object.

RecordSetFilterCriteria isn’t available for report types.

Associated Objects

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

RecordsetFilterCriteriaFeed
Feed tracking is available for the object.
RecordsetFilterCriteriaHistory
History is available for tracked fields of the object.
RecordsetFilterCriteriaOwnerSharingRule
Sharing rules are available for the object.
RecordsetFilterCriteriaShare
Sharing is available for the object.