Find Design Themes
{ findThemeByName }
Returns a list of design themes based on search criteria.
Method
/API3/themes/findThemeByName
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
Input Parameters
Name
searchCriteria
Object Type
Description
The search criteria for finding materialized data elements.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
The object of theme ID's and names. Note that the response is returned as a list of items of this object type.
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/themes/findThemeByName" \
-d '{
"searchValue" : "searchValue"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ThemesServiceApi;
import java.util.*;
import java.time.*;
public class ThemesServiceApiExample {
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
ThemesServiceApi apiInstance = new ThemesServiceApi();
// Initialize the searchCriteria parameter object for the call
SearchCriteria searchCriteria = ; // Create the input object for the operation, type: SearchCriteria
try {
// "array[ThemeListObject]" is only psaudo-code to symbolize list of type and not the actual usage
array[ThemeListObject] result = apiInstance.findThemeByName(searchCriteria);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ThemesServiceApi#findThemeByName");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ThemesServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const searchCriteria = ; // {SearchCriteria}
api.findThemeByName(searchCriteria).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 findThemeByNameExample
{
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 ThemesServiceApi();
// Initialize the searchCriteria parameter object for the call
var searchCriteria = new SearchCriteria(); // SearchCriteria |
try {
// Returns a list of design themes based on search criteria.
// "array[ThemeListObject]" is only psaudo-code to symbolize array of type and not the actual usage
array[ThemeListObject] result = apiInstance.findThemeByName(searchCriteria);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ThemesServiceApi.findThemeByName: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ThemesServiceApi
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 = ThemesServiceApi(api_client)
# Initialize the searchCriteria parameter object for the call
searchCriteria = # SearchCriteria |
try:
# Returns a list of design themes based on search criteria.
api_response = api_instance.find_theme_by_name(searchCriteria)
pprint(api_response)
except ApiException as e:
print("Exception when calling ThemesServiceApi->findThemeByName: %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\ThemesServiceApi();
$searchCriteria = ; // SearchCriteria |
try {
$result = $api_instance->findThemeByName($searchCriteria);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ThemesServiceApi->findThemeByName: ', $e->getMessage(), PHP_EOL;
}
?>