Newer Version Available

This content describes an older version of this product. View Latest

FlowOrchestrationInstance

Represents a run-time instance of an orchestration. This object is available in API version 53.0 and later.

Supported Calls

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

Special Access Rules

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.

Fields

Field Details
AuxiliaryTriggeringRecord
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The related object ID or service appointment ID. This fields isn’t used by flow approval processes or orchestrations. This field is available in API version 65.0 and later.
CurrentStage
Type
string
Properties
Filter, Group, Nillable, Sort
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. This field is available in API version 62.0 and later.
Duration
Type
long
Properties
Filter, Group, Nillable, Sort
Description
The duration of the orchestration instance in seconds. Durations are incremented until the orchestration is completed, canceled, or ends in an error. This field is available in API version 62.0 and later.
FlowDefinitionVersionName
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The fully qualified API name of the underlying orchestration.
Possible values are active flow approval processes and orchestrations in the org. This field is available in API version 62.0 and later.
FlowType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The flow type of the orchestration that created the orchestration work item.
Valid values are:
  • ApprovalOrchAutolnch—Autolaunched Flow Approval Process
  • ApprovalOrchRecTrigAftSave—Record-Triggered After Save Flow Approval Process
  • ExtSysChgFlowAppvl—External System Change-Triggered Flow Approval Process
  • ExtSysChgOrch—External System Change-Triggered Orchestration
  • OrchAutolnch—Autolaunched No Trigger Orchestration
  • OrchRecTrigAftSave—Record-Triggered After Save Orchestration
This field is available in API version 62.0 and later.
InterviewId
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
Lookup
Refers To
FlowInterview
IsDebugRun
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the instance was executed from a debug run. The default value is false.
This field is available in API version 65.0 and later.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent time a user viewed a record related to the orchestration run. This field is available in API version 55.0 and later.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent time a user viewed the orchestration run. This field is available in API version 55.0 and later.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name for the orchestration instance.
OrchestrationDeveloperName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The developer name of the flow definition associated with the orchestration run. This field is available in API version 55.0 and later.
OrchestrationLabel
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The label of the orchestration. This field is available in API version 63.0 and later.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
The ID of the automated process user. This field is available in API version 56.0 and later.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
User
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort, Update
Description
The status of the orchestration run. Valid values are:
  • Canceled—The orchestration instance was canceled.
  • Completed—The orchestration instance completed.
  • Error—The orchestration instance, or a stage or step within the orchestration instance, encountered an error.
  • InProgress—The orchestration instance is in progress.
  • Suspended—The orchestration instance was suspended.
TriggeringRecord
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the record that triggered the record-triggered orchestration. This field is available in API version 62.0 and later.
TriggeringRecordType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the Salesforce object configured to trigger the orchestration. This field is available in API version 64.0 and later.

Associated Objects

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 and later.

FlowOrchestrationInstanceFeed
Feed tracking is available for the object.
FlowOrchestrationInstanceHistory
History is available for tracked fields of the object.
FlowOrchestrationInstanceOwnerSharingRule
Sharing rules are available for the object. This object is available in API version 56.0 and later.
FlowOrchestrationInstanceShare
Sharing is available for the object. This object is available in API version 56.0 and later.