Newer Version Available

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

FlowDefinitionView

Represents the description of a flow definition. This object is available in API version 46.0 and later.

Supported Calls

query(), retrieve()

Fields

Field Details
ActiveVersionId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The ID of the active flow version.
ApiName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The API name of the flow definition.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Flow definition information, specified by the org’s admin.
DurableId
Type
ID
Properties
Filter, Group, Nillable, Sort
Description
The ID of the flow definition.
Label
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The label of the flow definition.
LatestVersionId
Type
ID
Properties
Filter, Group, Nillable, Sort
Description
The ID of the latest flow version, regardless of the flow’s status.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with the flow definition.
ProcessType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of the flow. Valid values are:
  • Appointments—A flow for Lightning Scheduler. This value is available in API version 44.0 and later.
  • AutoLaunchedFlow—A flow that doesn’t require user interaction.
  • ContactRequestFlow—A flow that lets customers request that customer support get back to them. This flow is used to create contact request records. This value is available in API version 45.0 and later.
  • CustomEvent—A process that is invoked when it receives a platform event message. In the UI, it’s an event process. This value is available in API version 41.0 and later.
  • FieldServiceMobile—A flow for the Field Service Lightning mobile app. This value is available in API version 39.0 and later.
  • FieldServiceWeb—A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later.
  • Flow—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab.
  • InvocableProcess—A process that can be invoked by another process or the Invocable Actions resource in the REST API. This value is available in API version 38.0 and later.
  • Survey—A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later.
  • Workflow—A process that is invoked when a record is created or edited. In the UI and Salesforce Help, it’s a record change process.

These values are reserved for future use.

  • ActionCadenceFlow
  • ActionPlan
  • CheckoutFlow
  • DigitalForm
  • JourneyBuilderIntegration
  • LoginFlow
  • OrchestrationFlow
  • TransactionSecurityFlow
  • UserProvisioningFlow

This value has significant impact on validation when saving the flow and on the flow’s runtime behavior. Don’t change this value unless you understand the flow properties of the specified type.

Note

Across flow versions, you can change the type only from Flow to AutolaunchedFlow or vice versa.

Usage

Use this object to query information about flow definitions.