ApptBundleConfig

Represents the general parameters that define the behavior of the bundle.

Introduced in API version 51.0.

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

• • Field Service must be enabled.
  • Bundling must be enabled in the Field Service Settings.
  • The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled.

• Type: multipicklist

• Properties: Create, Defaulted on create, Filter, Nillable, Update

• Description:

  The statuses of service appointment that are allowed to be bundled.

  The default value is None.

• Possible values:

  • Accepted — Accepted
  • Canceled — Canceled
  • Cannot Complete — Cannot Complete
  • Completed — Completed
  • Dispatched — Dispatched
  • In Progress — In Progress
  • None — None
  • Rejected — Rejected
  • Scheduled — Scheduled

• Type: multipicklist

• Properties: Create, Defaulted on create, Filter, Nillable, Update

• Description:

  The bundle statuses that when updated are inherited by the bundle members.

  The default value is None.

• Possible values:

  • Accepted — Accepted
  • Canceled — Canceled
  • Cannot Complete — Cannot Complete
  • Completed — Completed
  • Dispatched — Dispatched
  • In Progress — In Progress
  • None — None
  • Rejected — Rejected
  • Scheduled — Scheduled

• Type: reference

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description:

  The criteria that causes a bundle service appointment to be unbundled.

  This is a relationship field.

• Relationship name: CriteriaForAutoUnbundling

• Relationship type: relationship

• Refers to: RecordsetFilterCriteria

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Introduced: API version 57.0
• Description: If the bundle members aren’t in the same location, add travel time between them to the bundle’s duration according to their sort order. The default value is false.
• Default value: false

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Introduced: API version 63.0
• Description: If the bundle has no remaining bundle members, the bundle is deleted.
• Default value: false

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

• Introduced: API version 63.0

• Description:

  The status from the Canceled category that a bundle service appointment changes to if it has no remaining bundle members, but still appears in the appointment list.

  Possible values are determined by the org’s statuses.

  The default value is None.

• Type: multipicklist

• Properties: Create, Defaulted on create, Filter, Nillable, Update

• Description:

  The bundle member statuses that aren’t overridden when the bundle’s status is updated.

  The default value is None.

• Possible values:

  • Accepted — Accepted
  • Canceled — Canceled
  • Cannot Complete — Cannot Complete
  • Completed — Completed
  • Dispatched — Dispatched
  • In Progress — In Progress
  • None — None
  • Rejected — Rejected
  • Scheduled — Scheduled

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: The name of the Appointment Bundle Config.

• Type: multipicklist

• Properties: Create, Defaulted on create, Filter, Nillable, Update

• Description:

  The statuses of service appointments that are allowed to be removed from a bundle.

  The default value is None.

• Possible values:

  • Accepted — Accepted
  • Canceled — Canceled
  • Cannot Complete — Cannot Complete
  • Completed — Completed
  • Dispatched — Dispatched
  • In Progress — In Progress
  • None — None
  • Rejected — Rejected
  • Scheduled — Scheduled

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Description:

  The status that a service appointment is given when it’s removed from a bundle.

  The default value is None.

• Possible values:

  • Accepted — Accepted
  • Canceled — Canceled
  • Cannot Complete — Cannot Complete
  • Completed — Completed
  • Dispatched — Dispatched
  • In Progress — In Progress
  • None — None
  • Rejected — Rejected
  • Scheduled — Scheduled

• Type: multipicklist

• Properties: Create, Defaulted on create, Filter, Nillable, Update

• Description:

  The statuses that aren’t updated when a bundle is unbundled.

  The default value is None.

• Possible values:

  • Accepted — Accepted
  • Canceled — Canceled
  • Cannot Complete — Cannot Complete
  • Completed — Completed
  • Dispatched — Dispatched
  • In Progress — In Progress
  • None — None
  • Rejected — Rejected
  • Scheduled — Scheduled

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.

• ApptBundleConfigHistory

• ApptBundleConfigFeed