Newer Version Available

This content describes an older version of this product. View Latest

FldSvcObjChg

Represents a change made to one of a service appointment’s tracked fields. This object is available in API version 63.0 and later.

Supported Calls

describeLayout(), describeSObjects(), query(), retrieve()

Special Access Rules

  • Field Service must be enabled.
  • The Field Service managed package must be installed.
  • The Track the lifecycle of service appointments setting in Setup | Field Service Settings must be enabled.
  • The Platform Integration User must have the Manage Service Appointment Lifecycle and the View Service Appointment Lifecycle permissions.
  • To view this object, users must have the View Service Appointment Lifecycle user permission.

Fields

Field Details
Activity
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The available scheduling activities for the service appointment.
Possible values are:
  • AddedToBundle—Currently not supported
  • BundleMemberAdded—Currently not supported
  • BundleMemberRemoved—Currently not supported
  • Created
  • Deleted
  • RemovedFromBundle—Currently not supported
  • Rescheduled—An appointment is considered ‌rescheduled if a change is made to its assigned service resource or to its scheduled start time.
  • Scheduled
  • ServiceResourceAssigned
  • StatusChanged—The service appointment status was changed. The manual activities of scheduling, rescheduling, and unscheduling are also reported as status changes because they change the status of an appointment.
  • Unscheduled
  • Updated—Captures changes made to one or more of the tracked scheduling fields that aren’t associated with another activity.
ActivityDetails
Type
string
Properties
Filter, Nillable, Sort
Description
Details about the scheduling activity such as the scheduling policy that was used and the unscheduling reason (when applicable).
ActivityTimeStamp
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time of when the change to the service appointment was made.
IsPrimary
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the change was made directly to the service appointment or indirectly. If the change was made directly to the appointment, it’s flagged as Primary. If it was made to another appointment and affected this one, it’s flagged as Secondary.
OriginalSvcAppointment
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The ID of the service appointment that was changed. The field value isn’t deleted when the Service Appointment object is deleted.
ServiceAppointmentId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the service appointment that was changed. Because this is a relationship field, the field value is deleted when the Service Appointment object is deleted.
This field is a relationship field.
Relationship Name
ServiceAppointment
Relationship Type
Lookup
Refers To
ServiceAppointment
TimeZone
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The time zone of the service appointment or the assigned resource.
Transaction
Type
string
Properties
Filter, Nillable, Sort
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.
UserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The user who made the change to the service appointment. If an activity is a scheduled job, it’s registered with the System Administrator user who configured it.
This field is a relationship field.
Relationship Name
User
Relationship Type
Lookup
Refers To
User