Get a Tenant's Public Folders

{ getTenantPublicOrGroupFolder }

Gets the public root folders for a tenant.

Method

/API3/content/getTenantPublicOrGroupFolder
  • API Section: /API3/content
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by Enterprise Admin users only
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    folderTenantObject

    Object Type

    Description

    The folder for a tenant object.

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Pyramid Content item object.

    Notes

    This returns either the Group or Public folders for the specified tenant.

    Examples

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/content/getTenantPublicOrGroupFolder" \
     -d '{
      "tenantId" : "tenantId",
      "validRootFolderType" : "Private"
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.ContentServiceApi;
    
    import java.util.*;
    
    public class ContentServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            ContentServiceApi apiInstance = new ContentServiceApi();
            // Initialize the folderTenantObject parameter object for the call
            FolderTenantObject folderTenantObject = ; // FolderTenantObject | 
    
            try {
                PyramidContentItem result = apiInstance.getTenantPublicOrGroupFolder(folderTenantObject);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling ContentServiceApi#getTenantPublicOrGroupFolder");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
    const folderTenantObject = ; // {FolderTenantObject} 
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getTenantPublicOrGroupFolder(folderTenantObject, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class getTenantPublicOrGroupFolderExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new ContentServiceApi();
            // Initialize the folderTenantObject parameter object for the call
            var folderTenantObject = new FolderTenantObject(); // FolderTenantObject | 
    
            try {
                // Gets the public root folders for a tenant.
                PyramidContentItem result = apiInstance.getTenantPublicOrGroupFolder(folderTenantObject);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentServiceApi.getTenantPublicOrGroupFolder: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.ContentServiceApi(api_client)
        # Initialize the folderTenantObject parameter object for the call
        folderTenantObject =  # FolderTenantObject | 
    
        try:
            # Gets the public root folders for a tenant.
            api_response = api_instance.get_tenant_public_or_group_folder(folderTenantObject)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling ContentServiceApi->getTenantPublicOrGroupFolder: %s\n" % e)
    setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
    $folderTenantObject = ; // FolderTenantObject | 
    
    try {
        $result = $api_instance->getTenantPublicOrGroupFolder($folderTenantObject);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ContentServiceApi->getTenantPublicOrGroupFolder: ', $e->getMessage(), PHP_EOL;
    }
    ?>