Newer Version Available

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

WorkStep

Represents a work step in a work plan. This object is available in API version 52.0 and later.

Supported Calls

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

Special Access Rules

Field Service must be enabled.

Fields

Field Details
ActionDefinition
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The platform action that the work step executes. The possible values are the names of the flow and quick actions configured in your org. To launch Lightning Web Components from Work Steps, you must use QuickAction on the action definition.
ActionType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of platform action that the work step is associated with.
Possible values are:
  • Flow
  • QuickAction
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The description of the work step.
EndTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time the work step ends. The value must be greater than or equal to StartTime.
ExecutionOrder
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The order in which the work step is executed. Only positive integer values or null are supported.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, it’s possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The user-defined name of the work step.
PausedFlowInterviewId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The auto-populated ID of the flow interview paused by a user.
StartTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time the work step starts.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The customizable status of the work order. Every status must be mapped to a status category, but there can be status categories not mapped to a status.
Possible values are:
  • Completed
  • In Progress
  • New
  • Not Applicable
  • Paused
StatusCategory
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The category that each status value belongs to. Each default status category is mapped to the corresponding default status. If you create a custom status, you must indicate which status category it belongs to. To learn which processes reference StatusCategory, see How are Status Categories Used?.
Possible values are:
  • Completed
  • InProgress
  • New
  • NotApplicable
  • Paused
WorkOrderId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the work order.
WorkOrderLineItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the work order line item.
WorkPlanExecutionOrder
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The ID of the plan execution order.
WorkPlanId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the work plan.

Associated Objects

This object has these associated objects. Unless noted, they’re available in the same API version as this object.

WorkStepChangeEvent
Change events are available for the object.
WorkStepFeed
Feed tracking is available for the object.
WorkStepHistory
History is available for tracked fields of the object.