Skip Navigation

Newer Version Available

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

WorkStepStatus

Represents a picklist for a status category on a work step. This object is available in API version 52.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 Required. The name of the work step status.
IsDefault	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Controls whether this status is the default value of the picklist of the corresponding status category (`true`) or not (`false`). Default is `false`.
MasterLabel	Type string Properties Filter, Group, Nillable, Sort Description Required. The label of the work step status.
SortOrder	Type int Properties Filter, Group, Nillable, Sort Description Required. The order in which the work step statuses are displayed in the status category's picklist.
StatusCode	Type picklist Properties Required. Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The status category that this status belongs to. Possible values are: `Completed` `InProgress` `New` `NotApplicable` `Paused`