Returns the data catalog for a model
{ getUserDataCatalog }
Returns the user data catalog of the selected model in a JSON structure format.
Method
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
Input Parameters
Name
connectionStringId
Type
string
Description
The Model's connection ID
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Describes the discover model
Notes
There are two levels of the Data Catalog. The 'exportDataCatalog' function retrieves the data catalog based on the materialized model, encompassing comprehensive information about tables, columns (both visible and invisible), measures, relationships, translations, and more. On the other hand, 'getUserDataCatalog' retrieves information about dimensions, measures, and calculations that the end-user has permission to access.
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
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/getUserDataCatalog" \
-d ''
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 connectionStringId parameter object for the call
String connectionStringId = connectionStringId_example; // Create the input object for the operation, type: String
try {
DiscoverDataCatalog result = apiInstance.getUserDataCatalog(connectionStringId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataSourcesServiceApi#getUserDataCatalog");
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 connectionStringId = connectionStringId_example; // {String}
api.getUserDataCatalog(connectionStringId).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 getUserDataCatalogExample
{
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 connectionStringId parameter object for the call
var connectionStringId = connectionStringId_example; // Create the input object for the operation, type: String |
try {
// Returns the user data catalog of the selected model in a JSON structure format.
DiscoverDataCatalog result = apiInstance.getUserDataCatalog(connectionStringId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DataSourcesServiceApi.getUserDataCatalog: " + 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 connectionStringId parameter object for the call
connectionStringId = connectionStringId_example # String |
try:
# Returns the user data catalog of the selected model in a JSON structure format.
api_response = api_instance.get_user_data_catalog(connectionStringId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataSourcesServiceApi->getUserDataCatalog: %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();
$connectionStringId = connectionStringId_example; // String |
try {
$result = $api_instance->getUserDataCatalog($connectionStringId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesServiceApi->getUserDataCatalog: ', $e->getMessage(), PHP_EOL;
}
?>