ShiftWorkTopic

Represents the relationship between a Shift object and a Work Type or Work Type Group object for Salesforce Scheduler. 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()

Special Access Rules

Salesforce Scheduler must be enabled.

Usage

For a ShiftWorkTopic record, you must specify either a work type or a work type group (based on the Salesforce Scheduler for Health Cloud option), or set AreAllTopicsSupported as true. Use WorkTypeGroupId for Salesforce Scheduler and use WorkTypeId only when the Salesforce Scheduler for Health Cloud option is enabled.

Fields

AreAllTopicsSupported

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the shift supports all work type or work type groups (true) or not (false).
Default value: false

AttendeeLimit

Type: int
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The maximum number of attendees for a group service appointment in a shift. This field is considered when the appointment mode is Group. Available in API version 61.0 and later.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The date and time that the current user last viewed a record related to this object.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this object.

MaxAppointments

Type: int
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: The maximum number of appointments allowed for each time slot for a shift. This field is considered when WorkTypeId or WorkTypeGroupId is provided. This field is available in API version 60.0 and later.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of this shift-work topic relationship.

ShiftId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The ID of the shift that’s related to the work type indicated in the WorkTypeId field or the work type group indicated in the WorkTypeGroupId field. This field is a relationship field.
Relationship Name: Shift
Relationship Type: Lookup
Refers To: Shift

WorkTypeGroupId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the work type group that’s related to the shift indicated in the ShiftId field. This field is a relationship field.
Relationship Name: WorkTypeGroup
Relationship Type: Lookup
Refers To: WorkTypeGroup

WorkTypeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the work type that’s related to the shift indicated in the ShiftId field. This field is a relationship field.
Relationship Name: WorkType
Relationship Type: Lookup
Refers To: WorkType

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.

ShiftWorkTopicChangeEvent: Change events are available for the object.

ShiftWorkTopicFeed: Feed tracking is available for the object.

ShiftWorkTopicHistory: History is available for tracked fields of the object.

ShiftWorkTopicOwnerSharingRule: Sharing rules are available for the object.

ShiftWorkTopicShare: Sharing is available for the object.