Newer Version Available

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

FlowRecordVersion

Represents the version of a flow. This object is available in API version 58.0 and later.

Supported Calls

query()

Special Access Rules

This object is available only in Salesforce Starter edition.

Fields

Field Name Details
ActivatedAt
Type
dateTime
Properties
Filter, Group, Sort
Description
The date and time when the flow was activated.
ActivatedBy
Type
text
Properties
Filter, Group, Sort
Description
The ID of the user that activated the flow.
FlowId
Type
text
Properties
Filter, Group, Sort
Description
The ID of the parent flow running this version.
Id
Type
text
Properties
Filter, Group, Sort
Description
The ID of the flow version.
ProgressStatus
Type
enum
Properties
Filter, Group, Sort
Description
The running status of the flow. Valid values are:
  • Canceled— Specifies a flow that was deactivated by a user. The flow doesn’t process previously added records and no additional records are added to this flow.
  • Completed— Indicates a flow that is complete. No additional records are eligible to be processed in this flow.
  • Draft— Indicates a flow that is under construction and isn’t active yet. This status can be invalid because it needs additional information before a user can activate it.
  • Error— Indicates a flow that has been deactivated because it encountered an error. When the error occurs, the error details are emailed to up to 5 users with the Manage Flows permission who most recently logged into Salesforce.
  • Finishing— Indicates a flow that was deactivated by a user, but is finishing records previously added that are eligible to run to completion. No additional records are added to this flow.
  • InProgress— Indicates a flow that is running or ready to run.
  • PreparingData— Indicates a flow that is preparing the resources it requires to run. This process can take up to 2 hours.
  • Scheduled— Indicates a flow scheduled to start on the date and time selected by the user.
VersionNumber
Type
number
Properties
Filter, Group, Sort
Description
The version number of the flow version.