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

102 lines
5.4 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "AssetShare - Data API",
"description": "Represents a sharing entry on an Asset. This object is available in API version 33.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AssetAccessLevel": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort",
"description": "Level of access that the User or Group has to the Asset. The possible values are: Read Edit All This value is not valid for creating or deleting records. This field must be set to an access level that is higher than the organizations default access level for cases."
},
"AssetId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "ID of the Asset associated with this sharing entry. This field can't be updated. This is a relationship field.",
"relationship_name": "Asset",
"relationship_type": "Lookup",
"refers_to": "Asset"
},
"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 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 Asset with them. Owner—The User is the owner of the Asset. Rule—The User or Group has access via an Asset sharing rule. GuestRule—The User or Group has access via an Asset guest user 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": "Filter, Group, Sort",
"description": "ID of the User or Group that has been given access to the Asset. 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": "Customer Portal users cant access this object.",
"usage": "This object allows you to determine which users and groups can view and edit Asset records owned by other users. If you attempt to create a new record that matches an existing record, request updates any modified fields and returns the existing record.\n\nThis object allows you to determine which users and groups can view and edit Asset records owned by other users.\n\nIf you attempt to create a new record that matches an existing record, request updates any modified fields and returns the existing record.",
"wsdl_segment": "```xml\n<complexType name=\"AssetShare\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Asset\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Asset\"/>\n <element name=\"AssetAccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"AssetId\" 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": {
"AssetAccessLevel": {
"field_label": "Asset Access",
"type": "picklist",
"length": "40"
},
"AssetId": {
"field_label": "Asset ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Asset 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"
]
}