--- schema_version: "1" id: b78858d230e4a68fe3136c71ce1f47453a81912efd8a4dc92d858a305fe159af title: FlowOrchestration collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_floworchestration.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_floworchestration.htm source_site: developer.salesforce.com content_type: documentation content_hash: 2bb55b655d12b0e095d5e1e1695ec3cd1661ff066a3c4cf16321e7781caf72c1 description: Represents the details of an orchestration definition. This object is available in API version 62.0 and later. --- # FlowOrchestration Represents the details of an orchestration definition. This object is available in API version 62.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update() ## Fields | Field | Details | | --- | --- | | ActiveVersionId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the active orchestration version. This field is a relationship field. This field is a relationship field. Relationship Name ActiveVersion Refers To FlowOrchestrationVersion | | ApiName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the the orchestration. | | ApiVersion | Type int Properties Filter, Group, Nillable, Sort Description The API version of the active orchestration or the last saved orchestration. | | AverageRunTime | Type int Properties Filter, Group, Nillable, Sort Description The average duration of an orchestration run that has completed without error. | | CompletionRate | Type percent Properties Filter, Nillable, Sort Description The percentage of the total number of orchestration runs that have completed without error. | | Description | Type textarea Properties Nillable, Update Description The description of the flow orchestration. | | FailedRunCount | Type int Properties Filter, Group, Nillable, Sort Description The number of orchestration runs that have failed. | | InstalledPackageName | Type string Properties Filter, Group, Nillable, Sort Description The API name of the installed package that the orchestration is a part of. | | IsCitizenEnabled | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration can be modified by non-admins. Valid value is False. The default value is false. | | IsOverridable | 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. | | IsTemplate | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the orchestration record is a template. The default value is false. | | LastReferencedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record. | | LastViewedDate | Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. | | ManageableState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the managable state of the orchestration that's contained in a package. Valid values are: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged | | Name | Type string Properties Filter, Group, idLookup, Sort, Update Description The label of the orchestration. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with the orchestration record. | | OrchestrationDefinition | Type string Properties Filter, Group, Nillable, Sort Description Represents the orchestration definition. | | OrchestrationLabel | Type string Properties Filter, Group, Nillable, Sort, Update Description The label of the orchestration. | | OrchestrationType | 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. Valid values are: - 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—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 —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 | | OverriddenById | 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 Refers To FlowOrchestration | | OverriddenOrchestrationId | 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 Refers To FlowOrchestration | | RunCount | Type int Properties Filter, Group, Nillable, Sort Description The number of orchestration runs that have been started across all orchestration versions. | | SourceTemplateId | Type reference Properties Filter, Group, Nillable, Sort Description The ID of the template that the orchestration was created from. This field is a relationship field. Relationship Name SourceTemplate Refers To FlowOrchestration | | Status | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the record. Valid values are: - Active—Active - Draft—Inactive - InvalidDraft—Draft - Obsolete—Inactive - UnderReview—Under Review | | TriggerType | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the trigger type for a record-triggered orchestration. Valid values are: - RecordAfterSave—Record—Run After Save | ## 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. [FlowOrchestrationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object.