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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "OpportunityShare - Data API",
  "description": "Represents a sharing entry on an Opportunity.",
  "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."
    },
    "OpportunityAccessLevel": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Level of access that the user or group has to the opportunity. The possible values are: Read Edit All—This value is not valid when creating, updating, or deleting records. This field must be set to an access level that’s higher than the org’s default access level for opportunities."
    },
    "OpportunityId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the opportunity associated with this sharing entry. This field can’t be updated. This is a relationship field.",
      "relationship_name": "Opportunity",
      "relationship_type": "Lookup",
      "refers_to": "Opportunity"
    },
    "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: Owner—The User is the owner of the opportunity. Manual—The User or Group has access because a user with “All” access manually shared the opportunity with the user or group. Rule—The User or Group has access via an opportunity sharing rule. GuestRule—The User or Group has access via an opportunity guest user sharing rule. ImplicitChild—The User or Group has access to the opportunity on the account associated with this opportunity. After faster account sharing recalculation is enabled, sharing entries with this value aren’t returned in queries. Instead of storing implicit child shares, record access is determined dynamically. 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 opportunity via an account relationship data sharing rule. Sales Team—The User has access to the opportunity because the user is on the opportunity sales team for the opportunity. The OpportunityTeamMember object sets the access level. See OpportunityTeamMember for more information. Territory—The forecast manager has access because they are assigned to a territory above the territory that is assigned the opportunity."
    },
    "UserOrGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the user or group that has been given access to the opportunity. 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 Opportunity object can access this object.",
  "usage": "This object allows you to determine which users and groups can view or edit opportunities owned by other users.",
  "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=\"OpportunityShare\">\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=\"Opportunity\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Opportunity\"/>\n        <element name=\"OpportunityAccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OpportunityId\" 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": "Opportunity 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"
    },
    "OpportunityAccessLevel": {
      "field_label": "Opportunity Access",
      "type": "picklist",
      "length": "40"
    },
    "OpportunityId": {
      "field_label": "Opportunity 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"
  ]
}