Get hierarchy security properties

{ getHierarchySecurity }

Gets hierarchy security for the given role.

Method

/API3/dataSources/getHierarchySecurity

  • API Section: /API3/dataSources
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Input Parameters

    Name

    getOverlaySecurityObject

    Object Type

    GetOverlaySecurityObject

    Description

    An object representing the data model overlay / security.

    Output Response

    Successful Result Code

    200

    Response Type

    HierarchyMeasureSecurityApiObject

    Description of Response Type

    Details of the security settings to be applied to a data model's hierarchies or measures.

    Code Snippets

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

    TypeScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/dataSources/getHierarchySecurity" \
 -d '{
  "modelId" : "modelId",
  "roleId" : "roleId"
}'

    import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;

import java.util.*;
import java.time.*;

public class DataSourcesServiceApiExample {
    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
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the getOverlaySecurityObject parameter object for the call
        GetOverlaySecurityObject getOverlaySecurityObject = ; // Create the input object for the operation, type: GetOverlaySecurityObject 

        try {
            HierarchyMeasureSecurityApiObject result = apiInstance.getHierarchySecurity(getOverlaySecurityObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#getHierarchySecurity");
            e.printStackTrace();
        }
    }
}

    import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const getOverlaySecurityObject = ; // {GetOverlaySecurityObject} 

api.getHierarchySecurity(getOverlaySecurityObject).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


    using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class getHierarchySecurityExample
{
    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 DataSourcesServiceApi();
        // Initialize the getOverlaySecurityObject parameter object for the call
        var getOverlaySecurityObject = new GetOverlaySecurityObject(); // GetOverlaySecurityObject | 

        try {
            // Gets measure security for the given role.
            HierarchyMeasureSecurityApiObject result = apiInstance.getHierarchySecurity(getOverlaySecurityObject);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.getHierarchySecurity: " + e.Message );
        }
    }
}


    import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
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' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = DataSourcesServiceApi(api_client)
    # Initialize the getOverlaySecurityObject parameter object for the call
    getOverlaySecurityObject =  # GetOverlaySecurityObject | 

    try:
        # Gets measure security for the given role.
        api_response = api_instance.get_hierarchy_security(getOverlaySecurityObject)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->getHierarchySecurity: %s\n" % e)
    <?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->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\DataSourcesServiceApi();
$getOverlaySecurityObject = ; // GetOverlaySecurityObject | 

try {
    $result = $api_instance->getHierarchySecurity($getOverlaySecurityObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourcesServiceApi->getHierarchySecurity: ', $e->getMessage(), PHP_EOL;
}
?>