WorkOrderLineItemStatus

Represents a possible status of a work order line item in field service.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Field Service must be enabled.

Fields

Field Name 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 work orders. Only one status value can be the default.
MasterLabel
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The label for the picklist value that appears in the UI.
SortOrder
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The value’s position in the drop-down list of values 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 which are identical to the default Status values.

Usage

The Status field on work order line items comes with the following values:
  • New—Line item was created, but there hasn’t yet been any activity.
  • In Progress—Work has begun.
  • On Hold—Work is paused.
  • Completed—Work is complete.
  • Cannot Complete—Work could not be completed.
  • Closed—All work and associated activity is complete.
  • Canceled—Work is canceled, typically before any work began.
The WorkOrderLineItemStatus object corresponds to the Status field. Adding a value to the Status field—for example, Canceled By Customer—creates a work order line item status record, and vice versa.

Work order line items also come with a StatusCategory 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, you may decide that it belongs in the Cannot Complete category. To learn which processes reference StatusCategory, see How are Status Categories Used?

Note