FlowInterview

Represents a flow interview. A flow interview is a running instance of a flow.

Supported Calls

delete(), describeLayout(), describeSObject(), getDeleted(), getUpdated(), query(), retrieve()

Special Access Rules

To delete a flow interview, you must have the “Manage Flow” user permission. All other calls require the “Run Flows” user permission or the Flow User field enabled on the user detail page.

Fields

Field Name Details
CurrentElement
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The flow element at which the interview is currently paused or waiting.
Guid
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Globally unique identifier for the interview.
InterviewLabel
Type
string
Properties
Filter, Nillable, Sort
Description
Label for the interview. This label helps users and administrators differentiate interviews from the same flow.

In the user interface, this label appears in the Paused Flow Interviews component on the user’s Home tab and in the Paused and Waiting Interviews list on the flow management page.

Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name for the interview.
OwnerId
Type
ID
Properties
Filter, Group, Sort
Description
The ID of the user who owns the interview. Only this user or an admin can resume the interview.
PauseLabel
Type
string
Properties
Filter, Nillable, Sort
Description
Information about why the interview was paused. This string is entered by the user who paused the flow interview. The label is Why Paused