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

48 lines
2.6 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage"
],
"title": "LeadOwnerSharingRule - Data API",
"description": "Represents the rules for sharing a lead with users other than the owner.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"Description": {
"type": "textarea",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later."
},
"DeveloperName": {
"type": "string",
"properties": "Create, Defaulted on 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. This field is available in API version 24.0 and later. 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. Leads owned by users in the source group trigger the rule to give access."
},
"LeadAccessLevel": {
"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"
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, 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. The target user or group is being given access."
}
},
"usage": "Use these objects to manage the sharing rules for leads. General sharing and Territory-related sharing use this object."
}