afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/FolderShare.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "FolderShare - Metadata API",
  "description": "Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer, Editor, or Manager access to the folder that contains the report or dashboard.",
  "file_information": "FolderShare objects are stored in the reports and dashboards directories. For each report or dashboard folder it contains, there’s a metadata file named FolderName-meta.xml. The FolderName-meta.xml metadata file contains the metadata information for that folder, such as the accessLevel. For example, if the reports directory contains a reports folder named myReportsFolder, it also has a myReportsFolder-meta.xml file at the same level as myReportsFolder.",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "accessLevel": {
      "type": "FolderShareAccessLevel (enumeration of type string)",
      "description": "Specifies the combination of actions that can be taken on the folder. Valid values are: View. User can run a report or refresh a dashboard, but can’t edit them. All users have at least Viewer access to report and dashboard folders that have been shared with them. (Some users can have administrative permissions that give them greater access.) EditAllContents. Users can view and modify the reports or dashboards in the folder, and move them to and from any other folders that they have equivalent access to. Manage. Users can do everything Viewers and Editors can do, plus control other users’ access to a folder.",
      "required": true
    },
    "sharedTo": {
      "type": "string",
      "description": "Specifies the user, group, or role that has the specified access level to the folder.",
      "required": true
    },
    "sharedToType": {
      "type": "FolderSharedToType (enumeration of type string)",
      "description": "Specifies the type of entity that the folder is shared with. Valid values are: Group. Users in a specified public group have the specified access level to the folder. Manager. Available in API version 29.0 and later. ManagerAndSubordinatesInternal. Available in API version 29.0 and later. Role. Users with a specified role have the specified access level to the folder. RoleAndSubordinates. Users with a specified role, and users with a role subordinate to that role, have the specified access level to the folder. Only available when digital experiences is enabled for your org and Experience Cloud site users are created with external account roles other than a shared person account role. RoleAndSubordinatesInternal. Users with a specified role and users with a role subordinate to that role, except public portal users, have the specified access level to the folder. Organization. All internal users have the specified access level to the folder. Territory. Users in a specified territory have the specified access level to the folder. TerritoryAndSubordinates. Users in a specified territory, and users in territories subordinate to the specified territory, have the specified access level to the folder. AllPrmUsers. All PRM Portal users have the specified level of access to the folder. User. The specified individual user has the specified level of access to the folder. PartnerUser. The specified individual user of a partner portal has the specified level of access to the folder. AllCspUsers. All Customer Success Portal users have the specified level of access to the folder. CustomerPortalUser. The specified individual user of a customer portal has the specified level of access to the folder. PortalRole. Users with a specified role in a portal have the specified access level to the folder. PortalRoleAndSubordinates. Portal users with a specified role, and portal users with a role subordinate to that role, have the specified access level to the folder.",
      "required": true
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"DashboardFolder\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Folder\">\n      <xsd:sequence/>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"DocumentFolder\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Folder\">\n      <xsd:sequence/>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"EmailFolder\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Folder\">\n      <xsd:sequence/>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"EmailTemplateFolder\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Folder\">\n      <xsd:sequence/>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Folder\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"accessType\" minOccurs=\"0\" type=\"tns:FolderAccessTypes\"/>\n        <xsd:element name=\"folderShares\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FolderShare\"/>\n        <xsd:element name=\"name\" type=\"xsd:string\"/>\n        <xsd:element name=\"publicFolderAccess\" minOccurs=\"0\" type=\"tns:PublicFolderAccess\"/>\n        <xsd:element name=\"sharedTo\" minOccurs=\"0\" type=\"tns:SharedTo\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"FolderShare\">\n  <xsd:sequence>\n    <xsd:element name=\"accessLevel\" type=\"tns:FolderShareAccessLevel\"/>\n    <xsd:element name=\"sharedTo\" type=\"xsd:string\"/>\n    <xsd:element name=\"sharedToType\" type=\"tns:FolderSharedToType\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"FolderShareAccessLevel\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"View\"/>\n    <xsd:enumeration value=\"EditAllContents\"/>\n    <xsd:enumeration value=\"Manage\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"FolderSharedToType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Group\"/>\n    <xsd:enumeration value=\"Role\"/>\n    <xsd:enumeration value=\"RoleAndSubordinates\"/>\n    <xsd:enumeration value=\"RoleAndSubordinatesInternal\"/>\n    <xsd:enumeration value=\"Manager\"/>\n    <xsd:enumeration value=\"ManagerAndSubordinatesInternal\"/>\n    <xsd:enumeration value=\"Organization\"/>\n    <xsd:enumeration value=\"Territory\"/>\n    <xsd:enumeration value=\"TerritoryAndSubordinates\"/>\n    <xsd:enumeration value=\"AllPrmUsers\"/>\n    <xsd:enumeration value=\"User\"/>\n    <xsd:enumeration value=\"PartnerUser\"/>\n    <xsd:enumeration value=\"AllCspUsers\"/>\n    <xsd:enumeration value=\"CustomerPortalUser\"/>\n    <xsd:enumeration value=\"PortalRole\"/>\n    <xsd:enumeration value=\"PortalRoleAndSubordinates\"/>\n    <xsd:enumeration value=\"ChannelProgramGroup\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"ReportFolder\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Folder\">\n      <xsd:sequence/>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"WaveAnalyticAssetCollection\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"collectionType\" type=\"xsd:string\"/>\n        <xsd:element name=\"color\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"folder\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"items\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:WaveAnalyticAssetCollectionItem\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"shares\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FolderShare\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"WaveApplication\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"assetIcon\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"folder\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"shares\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:FolderShare\"/>\n        <xsd:element name=\"templateOrigin\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"templateVersion\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a FolderShare component for a dashboard folder:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<DashboardFolder xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n  <folderShares>\n        <accessLevel>View</accessLevel>\n        <sharedTo>R1</sharedTo>\n        <sharedToType>Role</sharedToType>\n    </folderShares>\n</DashboardFolder>"
    },
    {
      "description": "Here’s an example of a FolderShare component for a report folder:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ReportFolder xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n  <folderShares>\n       <accessLevel>View</accessLevel>\n        <sharedTo>R1</sharedTo>\n        <sharedToType>Role</sharedToType>\n    </folderShares>\n</ReportFolder>"
    }
  ]
}