Add roles to a data source item with propagate down.
{ addRolesToItemAndPropagate }
Assign roles to a data source item and propagates them down to subordinate objects.
Method
/API3/dataSources/addRolesToItemAndPropagate
- Enterprise Admin
Input Parameters
Name
itemRoles
Object Type
Description
Object with roles and items to be added.
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Notes
Use this method to set roles on a data source server and then apply down to databases and models.
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/addRolesToItemAndPropagate" \
-d '{
"itemId" : "itemId",
"modelId" : "modelId",
"itemRolePairList" : [ {
"roleId" : "roleId"
}, {
"roleId" : "roleId"
} ],
"databaseId" : "databaseId",
"serverId" : "serverId"
}'
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 itemRoles parameter object for the call
ItemRolesToBeAdded itemRoles = ; // Create the input object for the operation, type: ItemRolesToBeAdded
try {
ModifiedItemsResult result = apiInstance.addRolesToItemAndPropagate(itemRoles);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataSourcesServiceApi#addRolesToItemAndPropagate");
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 itemRoles = ; // {ItemRolesToBeAdded}
api.addRolesToItemAndPropagate(itemRoles).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 addRolesToItemAndPropagateExample
{
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 itemRoles parameter object for the call
var itemRoles = new ItemRolesToBeAdded(); // ItemRolesToBeAdded |
try {
// Assign roles to a data source item and propagates them down to subordinate objects.
ModifiedItemsResult result = apiInstance.addRolesToItemAndPropagate(itemRoles);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DataSourcesServiceApi.addRolesToItemAndPropagate: " + 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 itemRoles parameter object for the call
itemRoles = # ItemRolesToBeAdded |
try:
# Assign roles to a data source item and propagates them down to subordinate objects.
api_response = api_instance.add_roles_to_item_and_propagate(itemRoles)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataSourcesServiceApi->addRolesToItemAndPropagate: %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();
$itemRoles = ; // ItemRolesToBeAdded |
try {
$result = $api_instance->addRolesToItemAndPropagate($itemRoles);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesServiceApi->addRolesToItemAndPropagate: ', $e->getMessage(), PHP_EOL;
}
?>