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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ContactShare - Data API",
  "description": "Represents a list of access levels to a Contact along with an explanation of the access level. For example, if you have access to a record because you own it, the ContactAccessLevel is All and RowCause is Owner.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "ContactId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "ID of the Contact associated with this sharing entry. This field can't be updated. This is a relationship field.",
      "relationship_name": "Contact",
      "relationship_type": "Lookup",
      "refers_to": "Contact"
    },
    "ContactAccessLevel": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Level of access that the User or Group has to cases associated with the account Contact. The possible values are: Read Edit All This value is not valid for create or update. This field must be set to an access level that is higher than the organization’s default access level for contacts."
    },
    "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."
    },
    "RowCause": {
      "type": "picklist",
      "properties": "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: Rule—The User or Group has access via a Contact sharing rule. GuestRule—The User or Group has access via a Contact guest user sharing rule. ImplicitChild—The User or Group has access to the Contact via sharing access on the associated Account. After faster account sharing recalculation is enabled for your org, sharing entries with this value aren’t returned in queries. Instead of storing implicit child shares, record access is determined dynamically. ImplicitPerson—The User or Group has access to the business contact of a person account via access to the person account itself. GuestPersonImplicit—The guest user has access to the business contact of a person account via a Contact sharing rule. PortalImplicit—The Contact is associated with the portal user. 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 Contact via an account relationship data sharing rule. Manual—The User or Group has access because a User with “All” access manually shared the Contact with them. Owner—The User is the owner of the Contact."
    },
    "UserOrGroupId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "ID of the User or Group that has been given access to the Contact. 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 Contact object can access this object.",
  "usage": "This object allows you to determine which users and groups can view or edit Contact records owned by other users. For more information, see the Faster Account Sharing Recalculation knowledge article.\n\nThis object allows you to determine which users and groups can view or edit Contact records owned by other users.\n\nFor more information, see the Faster Account Sharing Recalculation knowledge article.",
  "wsdl_segment": "```xml\n<complexType name=\"ContactShare\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Contact\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Contact\"/>\n        <element name=\"ContactAccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ContactId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"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": {
    "ContactAccessLevel": {
      "field_label": "Contact Access",
      "type": "picklist",
      "length": "40"
    },
    "ContactId": {
      "field_label": "Contact ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Contact 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"
    },
    "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"
  ]
}