--- schema_version: "1" id: 80f8c8ac370f24114817ea8aa47a4e8277d494198ecbc9e9152cbbfb3db322ff title: WorkStep collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_workstep.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_workstep.htm source_site: developer.salesforce.com content_type: documentation content_hash: 5464c359417f8d25d1f15dffbc572f0a0d8c2fc57af8d8262e9c2c121cfd8737 description: Represents a work step in a work plan. This object is available in API version 52.0 and later. --- # 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 interacted with this record, directly or indirectly. | | 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. | | ProcessType | Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The flow process type launched from the work step. Possible values are: - DataCaptureFlow—Data Capture Flow - DiscoveryFrameworkFlow—Discovery Framework Data Capture Flow (Beta) - FieldServiceMobileFlow—Field Service Mobile Flow The default value is DataCaptureFlow. | | 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?](https://help.salesforce.com/articleView?id=service.fs_status_categories.htm&type=5&language=en_US). 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [WorkStepFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [WorkStepHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object.