FlowDefinition

Represents the flow definition’s description and active flow version number.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

In API version 44.0, we recommend upgrading your flows to flow metadata file names without version numbers and discontinue using the FlowDefinition object to activate or deactivate a flow. Then use the Flow object to activate or deactivate a flow. For more information, see Upgrade Flow Files to API Version 44.0.

Important

If you deploy with flow definitions, the active version numbers in the flow definitions override the status fields in the flows. For example, the active version number in the flow definition is version 3, and the latest version of the flow is version 4 with the status field as Active. After you deploy your flow, the active version is version 3.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

FlowDefinitions are stored in the flowDefinitions directory of the corresponding package directory. The file name matches the flow definition’s unique full name, and the extension is .flowDefinition.

Version 

FlowDefinition is available in API version 34.0 and later.

Fields 

activeVersionNumber 

• Type: int
• Required: No
• Description: The version number of the active flow.

apiVersion 

• Type: int
• Required: No
• Description: Reserved for internal use.

description 

• Type: string
• Required: No
• Description: Description of the flow definition.

masterLabel 

• Type: string
• Required: No
• Description: Label for the flow definition. In managed packages, this field inherits the flow’s active version name. To change this label from a subscriber’s org, edit the packaged flow name.

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.