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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "LeadShare - Data API",
  "description": "Represents a sharing entry on a Lead.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "IsDeleted": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter",
      "description": "Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted."
    },
    "LeadAccessLevel": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Level of access that the User or Group has to the Lead. The possible values are: Read Edit All This value is not valid when creating or updating these records. This field must be set to an access level that is higher than the organization’s default access level for leads."
    },
    "LeadId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the Lead associated with this sharing entry. This field can’t be updated. This is a relationship field.",
      "relationship_name": "Lead",
      "relationship_type": "Lookup",
      "refers_to": "Lead"
    },
    "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. Values include: Manual—The User or Group has access because a user with “All” access manually shared the Lead with them. Owner—The User is the owner of the Lead. Rule—The User or Group has access via a Lead sharing rule. GuestRule—The User or Group has access via a Lead guest user sharing rule. LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group. ARImplicit—The User, who belongs to a partner or customer account, has access to the Lead via an account relationship data sharing rule."
    },
    "UserOrGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the User or Group that has been given access to the Lead. This field can’t be updated. This is a polymorphic relationship field.",
      "relationship_name": "UserOrGroup",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    }
  },
  "special_access_rules": "As of Summer ’20 and later, only users with access to the Lead object can access this object.",
  "usage": "This object allows you to determine which users and groups can view or edit leads owned by other users. If you attempt to create a record that matches an existing record, the existing record is returned.\n\nThis object allows you to determine which users and groups can view or edit leads owned by other users.\n\nIf you attempt to create a record that matches an existing record, the existing record is returned.",
  "wsdl_segment": "```xml\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<complexType name=\"LeadShare\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\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=\"Lead\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Lead\"/>\n        <element name=\"LeadAccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LeadId\" 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```",
  "field_reference": {
    "Id": {
      "field_label": "Lead 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"
    },
    "LeadAccessLevel": {
      "field_label": "Lead Access",
      "type": "picklist",
      "length": "40"
    },
    "LeadId": {
      "field_label": "Lead 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"
  ]
}