| 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.
|
| Builder |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The name of the tool that created this flow. Possible values are:
- Cloud Flow Designer
- Flow Builder
- Swing Designer
This field is available in API version 47.0 and later.
|
| Description |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Flow definition information, specified by the org’s admin.
|
| DurableId |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the flow definition.
|
| InstalledPackageName |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The name of the installed package that includes this flow
definition.
This field is available in API version 47.0 and later.
|
| IsActive |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the latest version of the flow definition is the
active flow version.
This field is available in API version 47.0 and later.
|
| IsOutOfDate |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the active flow version is the latest version of
the flow definition.
This field is available in API version 47.0 and later.
|
| IsTemplate |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the process or flow is
a template. When installed from managed packages, processes and
flows can’t be viewed or cloned by subscribers because of
intellectual property (IP) protection. But when those processes
and flows are templates, subscribers can open them in a builder,
clone them, and customize the clones.
This field is available in API version 47.0 and later.
|
| Label |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The label of the flow definition.
|
| LastModifiedBy |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Name of the user who last updated this flow definition.
This field is available in API version 47.0 and later.
|
| LatestVersionId |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the latest flow version, regardless of the flow’s
status.
|
| ManageableState |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates the manageable state of the flow that is contained in a
package. Possible values are:
- beta
- deleted
- deprecated
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged
This field is available in API version 47.0 and later.
|
| 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 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
- CartAsyncFlow
- CheckoutFlow
- DecisionStudio
- DigitalForm
- Journey
- JourneyBuilderIntegration
- LoginFlow
- ManagedContentFlow
- 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.
Across flow versions, you can
change the type only from Flow to AutolaunchedFlow or vice versa. Before you change the flow type, make sure that the
flow contains only elements, resources, and functionality that the new flow type
supports.
|
| TriggerType |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Specifies what causes the flow to run. If you exclude this field,
the flow has no trigger and starts only when a user or app launches
the flow. Valid value is:
-
Scheduled—The
flow starts at the scheduled time.
This field is available in API version 47.0 and later.
|
j