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

95 lines
5.0 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",
"wsdl_segment",
"field_reference"
],
"title": "IndividualShare - Data API",
"description": "Represents a list of access levels to a data privacy record along with an explanation of the access level. For example, if you have access to a record because you own it, the IndividualAccessLevel is All and RowCause is Owner. This object is available in API version 42.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"IndividualAccessLevel": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "Level of access that the user or group has to the data privacy record. The possible values include: Read Edit All (Except for create or update.) Set this field to an access level thats higher than your default access level for individuals."
},
"IndividualId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID of the Individual associated with this sharing entry. This field isnt available for updates. This is a relationship field.",
"relationship_name": "Individual",
"relationship_type": "Lookup",
"refers_to": "Individual"
},
"RowCause": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Reason that this sharing entry exists. If youre 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 cant be edited. Valid values include: Manual—The User or Group has access because a user with “All” access manually shared the data privacy record with them. Owner—The User is the owner of the data privacy record. Rule—The User or Group has access to the data privacy record via an Individual sharing rule. LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group."
},
"UserOrGroupId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "ID of the User or Group that has been given access to the data privacy record. This field isnt available for updates. This is a polymorphic relationship field.",
"relationship_name": "UserOrGroup",
"relationship_type": "Lookup",
"refers_to": "Group, User"
}
},
"usage": "This object lets you determine which users and groups can view or edit Individual records 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=\"IndividualShare\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Individual\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Individual\"/>\n <element name=\"IndividualAccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IndividualId\" 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```",
"field_reference": {
"Id": {
"field_label": "Individual Share ID",
"type": "id",
"length": "18"
},
"IndividualAccessLevel": {
"field_label": "Individual Access Level",
"type": "picklist",
"length": "40"
},
"IndividualId": {
"field_label": "Individual ID",
"type": "reference",
"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": "Apex Sharing Reason ID",
"type": "picklist",
"length": "40"
},
"UserOrGroupId": {
"field_label": "User/Group ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}