afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/FlowInterviewShare.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "FlowInterviewShare - Data API",
  "description": "Represents a sharing entry on a FlowInterview. This object is available in API version 33.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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.\n\nThis object lets you determine which users and groups can view and edit flow interviews that are owned by other users.\n\nIn 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.",
  "wsdl_segment": "```xml\n<complexType name=\"FlowInterviewShare\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"AccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowInterview\"/>\n        <element name=\"ParentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"RowCause\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserOrGroup\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"UserOrGroupId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n```",
  "field_reference": {
    "AccessLevel": {
      "field_label": "Custom Object Access",
      "type": "picklist",
      "length": "40"
    },
    "Id": {
      "field_label": "Custom Object Share ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "ParentId": {
      "field_label": "Parent ID",
      "type": "reference",
      "length": "18"
    },
    "RowCause": {
      "field_label": "Row Cause",
      "type": "picklist",
      "length": "40"
    },
    "UserOrGroupId": {
      "field_label": "User/Group ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}