FlowOrchestrationVersion
Represents the version of an orchestration.
Introduced in API version 62.0.
describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Description:
The ID of the user that activated the orchestration.
This field is a relationship field.
-
Relationship name: ActivatedBy
-
Relationship type: relationship
-
Refers to: User
- Type: datetime
- Properties: Filter, Nillable, Sort
- Description: The date and time when the orchestration was activated.
- Type: double
- Properties: Filter, Nillable, Sort
- Description: The API version of this orchestration record version.
- Type: textarea
- Properties: Nillable
- Description: The description of the flow orchestration version.
-
Type: reference
-
Properties: Filter, Group, Sort
-
Description:
The ID of the parent orchestration running this version.
This field is a relationship field.
-
Relationship name: FlowOrchestration
-
Relationship type: masterdetail
-
Refers to: FlowOrchestration
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Relationship name: InteractionDefVersion
-
Relationship type: relationship
-
Refers to: InteractionDefinitionVersion
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Description:
Indicates whether the orchestration that’s part of a managed package is overridable.
The default value is
false. -
Default value: false
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Description:
Indicates whether the orchestration record version is a template.
The default value is
false. -
Default value: false
- Type: string
- Properties: Filter, Group, idLookup, Sort
- Description: The label of the orchestration.
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: The orchestration’s flow type. FlowType consolidates ProcessType and TriggerType into one field. FlowType is used with permissions, so admins can control access to each flow type.
- Possible values:
- OrchAutolnch — OrchAutolnch — Autolaunched No Trigger Orchestration: Launches when invoked by Apex, REST API, custom buttons, or custom links. An orchestration lets you create a multi-step, multi-user process.
- OrchRecTrigAftSave — OrchRecTrigAftSave — Record-Triggered After Save Orchestration: Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction.
- CmsOrchAutolnch — CmsOrchAutolnch — CMS Workflow Orchestration Autolaunched: Launches when invoked from the Workflows component in a CMS workspace. This type of orchestration lets you create a multi-step, multi-user process to create, edit, organize, and manage digital content from a centralized location
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Description:
The ID of the orchestration that’s overriding the current orchestration.
This field is a relationship field.
-
Relationship name: OverriddenBy
-
Relationship type: relationship
-
Refers to: FlowOrchestration
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Description:
The ID of the orchestration that the current orchestration is overriding.
This field is a relationship field.
-
Relationship name: OverriddenOrchestration
-
Relationship type: relationship
-
Refers to: FlowOrchestration
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: The mode that the orchestration runs in.
- Possible values:
- DefaultMode — DefaultMode — The orchestration version runs in system or user context, depending on how the orchestration is launched.
- SystemModeWithSharing — SystemModeWithSharing — The orchestration version always runs in system mode with sharing. The orchestration respects org-wide default settings, role hierarchies, sharing rules, manual sharing, teams, and territories. But it doesn’t respect object permissions, field-level access, or other permissions of the running user.
- SystemModeWithoutSharing — SystemModeWithoutSharing — The orchestration version can access all data. In the UI, this value appears as System Context without Sharing—Access All Data.
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Relationship name: SourceTemplate
-
Relationship type: relationship
-
Refers to: FlowOrchestration
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: The ID of the template that the orchestration was created from. This is a relationship field.(Refers to Orchestration Record).
- Possible values:
- Active — Active
- Draft — Draft — Inactive
- InvalidDraft — InvalidDraft — Draft
- Obsolete — Obsolete — Inactive
- UnderReview — UnderReview — Under Review
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: The label of the object or platform event that triggers this flow.
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Description: The version number of the orchestration version.
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.