WorkStep

Represents a work step in a work plan.

Introduced in API version 49.0.

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

  • Field Service must be enabled.
  • 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.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: The type of platform action that the work step is associated with.
  • Possible values:
    • Flow — Flow
    • QuickAction — QuickAction
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The description of the work step.
  • 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.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • 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.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. The user-defined name of the work step.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 54.0
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The auto-populated ID of the flow interview paused by a user.
  • Relationship name: PausedFlowInterview
  • Relationship type: relationship
  • Refers to: FlowInterview

  • Type: picklist

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

  • Introduced: API version 64.0

  • Description:

    The flow process type launched from the work step.

    The default value is DataCaptureFlow.

  • Possible values:

    • DataCaptureFlow — DataCaptureFlow (default) — Data Capture Flow
    • DiscoveryFrameworkFlow — DiscoveryFrameworkFlow — Discovery Framework Data Capture Flow (Beta)
    • FieldServiceMobileFlow — FieldServiceMobileFlow — Field Service Mobile Flow

  • Default value: DataCaptureFlow

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time the work step starts.
  • 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:
    • Completed — Completed
    • In Progress — In Progress
    • New — New
    • Not Applicable — Not Applicable
    • Paused — Paused
  • 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:
    • Completed — Completed
    • InProgress — InProgress
    • New — New
    • NotApplicable — NotApplicable
    • Paused — Paused
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the work order.
  • Relationship name: WorkOrder
  • Relationship type: relationship
  • Refers to: WorkOrder
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the work order line item.
  • Relationship name: WorkOrderLineItem
  • Relationship type: relationship
  • Refers to: WorkOrderLineItem
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the plan execution order.
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The ID of the work plan.
  • Relationship name: WorkPlan
  • Relationship type: masterdetail
  • Refers to: WorkPlan

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.