FlowOrchestrationInstance | Object Reference for the Salesforce Platform

Supported Calls

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

Special Access Rules

All calls require the “Manage Flows” user permission. Or if Override default behavior and restrict access to enabled profiles or permission sets is selected for an autolaunched orchestration, access to that specific orchestration and its interview is given to users by profile or permission set.

Fields

Field	Details
InterviewId	Type reference Properties Filter, Group, Nillable, Sort 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
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.
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 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.

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.