ProductServiceCampaignStatus

Represents a status for a product service campaign in field service. This object is available in API version 51.0 and later.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Field Service must be enabled.

Fields

Field	Details
ApiName	Type string Properties Filter, Group, idLookup, Sort Description The API name of the status value.
IsDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the status value is the default status on product service campaigns when `true`. Only one status value can be the default.
MasterLabel	Type string Properties Filter, Group, Nillable, Sort Description The label for the picklist value in the UI.
SortOrder	Type int Properties Filter, Group, Nillable, Sort Description The value’s position in the dropdown list in the UI.
StatusCode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that the value corresponds to. The Status Category field has seven values that are identical to the default Status values.

Usage

The Status field on product service campaigns comes with the following values:

New—Product service campaign created, but there hasn’t been any activity.
In Progress—Work has begun.
On Hold—Work is paused.
Completed—Work is complete.
Cannot Complete—Work couldn’t be completed.
Closed—All work and associated activity is complete.
Canceled—Work is canceled, typically before any work began.

The ProductServiceCampaignStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Supplier—creates a product service campaign status record, and vice versa.

Product service campaigns also come with a Status Category field whose values are identical to the default status values. If you create custom status values, you must indicate which category it belongs to. For example, if you create a Customer Absent value, add it to the Cannot Complete category. To learn which processes reference StatusCategory, see How are Status Categories Used?

Note

Object Reference for Salesforce and Lightning Platform

ProductServiceCampaignStatus

Supported Calls

Special Access Rules

Fields

Usage