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

48 lines
3.4 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"usage"
],
"title": "FlowInterviewOwnerSharingRule - Data API",
"description": "Represents the rules for sharing a FlowInterview with users other than the owner. This object is available in API version 33.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"AccessLevel": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "A value that represents the type of sharing being allowed. 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."
},
"Description": {
"type": "textarea",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "A description of the sharing rule. Maximum size is 1000 characters."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the objects name in a managed package and the changes are reflected in a subscribers organization. Corresponds to Rule Name in the user interface. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record."
},
"GroupId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID representing the source group."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface."
},
"UserOrGroupId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID representing the target user or group thats given access."
}
},
"usage": "Use this object to manage the sharing rules for FlowInterview records. General sharing uses this object. 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 orgs Process Automation Settings in Setup.\n\nUse this object to manage the sharing rules for FlowInterview records. General sharing uses this object.\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 orgs Process Automation Settings in Setup."
}