FlowOrchestrationStepInstance
Represents a run-time instance of a step in a run-time instance of a stage of a run-time instance of an orchestration.
Introduced in API version 53.0.
This read-only object is available in API version 53.0 and later.
describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
- If sharing rules are defined for FlowOrchestrationStepInstance, they determine access to specific orchestration step run records. Or the user must have the View All Data permission.
- Type: textarea
- Properties: Create, Nillable, Update
- Introduced: API version 63.0
- Description: The description of the step.
- Type: textarea
- Properties: Create, Nillable, Update
- Introduced: API version 61.0
- Type: string
- Properties: Create, Filter, Group, Sort, Update
- Description: The label of the step.
- Type: string
- Properties: Create, Filter, Group, idLookup, Sort, Update
- Description: The API name of the step.
-
Type: reference
-
Properties: Create, Filter, Group, Sort, Update
-
Description:
The ID of the FlowOrchestrationInstance associated with the orchestration step instance.
This field is a relationship field.
-
Relationship name: OrchestrationInstance
-
Relationship type: relationship
-
Refers to: FlowOrchestrationInstance
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 56.0
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 56.0
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 62.0
-
Type: reference
-
Properties: Create, Filter, Group, Sort, Update
-
Description:
The ID of the FlowOrchestrationStageInstance associated with the orchestration step instance.
This field is a relationship field.
-
Relationship name: StageInstance
-
Relationship type: relationship
-
Refers to: FlowOrchestrationStageInstance
- Type: picklist
- Properties: Create, Filter, Group, Restricted picklist, Sort, Update
- Description: The status of the orchestration step instance.
- Possible values:
- Completed — Completed — The step instance completed.
- Discontinued — Discontinued — The step instance was in progress or completed when it’s associated stage instance completed, or the step was in progress or completed when the orchestration instance encountered an error.
- Error — Error — The step instance encountered an error or the autolaunched flow associated with a step instance encountered an error.
- InProgress — InProgress — The step instance is running, the step instance was in progress when its associated stage encountered an error, or the screen flow associated with the step instance encountered an error.
- NotStarted — NotStarted — The step instance was created, but hasn’t met its entry condition.
- Type: picklist
- Properties: Create, Filter, Group, Restricted picklist, Sort, Update
- Description: The type of step.
- Possible values:
- InteractiveStep — InteractiveStep — Interactive Step
- BackgroundStep — BackgroundStep — Background Step
- AynchronousBackgroundStep — AynchronousBackgroundStep — Asynchronous Background StepThis value is available in API version 54.0 and later.
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.