FlowOrchestrationInstance
Represents a run-time instance of an orchestration.
Introduced in API version 53.0.
create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
- If sharing rules are defined for FlowOrchestrationInstance, they determine access to specific orchestration run records. Or the user must have the View All Data permission.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 65.0
- Description: The related object ID or service appointment ID. This fields isn’t used by flow approval processes or orchestrations.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0
- Description: The API name of the stage that was running when the orchestration run was paused or failed because of an error in an action called by a step.
- Type: long
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0
- Description: The duration of the orchestration instance in seconds. Durations are incremented until the orchestration is completed, canceled, or ends in an error.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 62.0
-
Relationship name: FlowDefinitionVersion
-
Relationship type: relationship
-
Refers to: InteractionDefinitionVersion
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
-
Introduced: API version 62.0
-
Description:
The fully qualified API name of the underlying orchestration.
Possible values are active flow approval processes and orchestrations in the org.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 62.0
- Description: The flow type of the orchestration that created the orchestration work item.
- Possible values:
- ApprovalOrchAutolnch — ApprovalOrchAutolnch — Autolaunched Flow Approval Process
- ApprovalOrchRecTrigAftSave — ApprovalOrchRecTrigAftSave — Record-Triggered After Save Flow Approval Process
- ExtSysChgFlowAppvl — ExtSysChgFlowAppvl — External System Change-Triggered Flow Approval Process
- ExtSysChgOrch — ExtSysChgOrch — External System Change-Triggered Orchestration
- OrchAutolnch — OrchAutolnch — Autolaunched No Trigger Orchestration
- OrchRecTrigAftSave — OrchRecTrigAftSave — Record-Triggered After Save Orchestration
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description:
The globally unique flow interview ID associated with the orchestration instance.
This field is a relationship field.
-
Relationship name: Interview
-
Relationship type: relationship
-
Refers to: FlowInterview
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 65.0
- Description: Indicates whether the instance was executed from a debug run. The default value is
false. - Default value: false
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: The name for the orchestration instance.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 55.0
- Description: The developer name of the flow definition associated with the orchestration run.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 63.0
- Description: The label of the orchestration.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 56.0
- Type: picklist
- Properties: Create, Filter, Group, Restricted picklist, Sort, Update
- Description: The status of the orchestration run.
- Possible values:
- Canceled — Canceled — The orchestration instance was canceled.
- Completed — Completed — The orchestration instance completed.
- Error — Error — The orchestration instance, or a stage or step within the orchestration instance, encountered an error.
- InProgress — InProgress — The orchestration instance is in progress.
- Suspended — Suspended — The orchestration instance was suspended.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 62.0
- Description: The ID of the record that triggered the record-triggered orchestration.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 64.0
- Description: The name of the Salesforce object configured to trigger the orchestration.
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.