ServiceAppointmentGroup

Stores information about a group of related service appointments. This object is available in API version 56.0 and later.

Supported Calls

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

Fields

AppointmentGroupType

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Specifies the type of appointment group associated with the service appointment group.
Possible values:
- Multi-Step
- Recurring

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Stores information about the service appointment group.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced the record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed the record.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the service appointment group.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the record owner.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

ReferenceRecordId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents the record associated with the service appointment group.

This field is a polymorphic relationship field.
Relationship Name: ReferenceRecord
Relationship Type: Lookup
Refers To: Account, CareProgramEnrollee, Case, Opportunity

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the status of the service appointment group.
Default value: None
Possible values:
- Awaiting Approval
- Canceled
- None
- Scheduled

StatusCode

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Specifies the status code used for scheduling the service appointment group.
Possible values:
- Canceled
- Processed
- Proposed

WorkProcedureId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the work procedure associated with the service appointment group.

This field is a relationship field.
Relationship Name: WorkProcedure
Relationship Type: Lookup
Refers To: WorkProcedure

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.

ServiceAppointmentGroupChangeEvent (API version 60.0): Change events are available for the object.
ServiceAppointmentGroupFeed: Feed tracking is available for the object.
ServiceAppointmentGroupHistory: History is available for tracked fields of the object.
ServiceAppointmentGroupOwnerSharingRule: Sharing rules are available for the object.
ServiceAppointmentGroupShare: Sharing is available for the object.