Newer Version Available

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

FlowInterviewShare

Represents a sharing entry on a FlowInterview. This object is available in API version 33.0 and later.

You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all.

While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur.

Note

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields.

Field Details
AccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the User or Group has to the FlowInterview. The possible values are:
  • Read
  • Edit—In API version 42.0 and later, when Let users resume shared flow interviews is enabled for your org, users can resume all flow interviews that they have edit access to.
  • All—This value is not valid for creating or deleting records.
ParentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the FlowInterview associated with this sharing entry.
This is a relationship field.
Relationship Name
Parent
Relationship Type
Lookup
Refers To
FlowInterview
RowCause
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited.
Valid values include:
  • Manual—The User or Group has access because a user with “All” access manually shared the FlowInterview with them.
  • Owner—The User is the owner of the FlowInterview.
  • Rule—The User or Group has access via a FlowInterview sharing rule.
  • GuestRule—The User or Group has access via a FlowInterview guest user sharing rule.
UserOrGroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the User or Group that has been given access to the FlowInterview. This field can't be updated.
This is a polymorphic relationship field.
Relationship Name
UserOrGroup
Relationship Type
Lookup
Refers To
Group, User

Usage

This object lets you determine which users and groups can view and edit flow interviews that are owned by other users.

In API version 42.0 and later, when Let users resume shared flow interviews is enabled for your org, users can resume all flow interviews that they have edit access to. When that setting is disabled, only the owner or a flow admin can resume a flow interview. To disable this setting, go to your org’s Process Automation Settings in Setup.