Gets tag data
{ getTagData }
Returns the Tag with its metadata
Method
/API3/content/getTagData
- Enterprise Admin
Input Parameters
Name
tagId
Type
string
Description
The system tag ID
Output Response
Successful Result Code
200
Response Type
Description of Response Type
The tag object used to capture a tag's settings.
Examples

This example demonstrates how to find item's and the manipulation of content tags.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.
// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";
// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
"userName":"adminUser",
"password":"abc123!"
},"",false);
//step 2: add a tag to the system
let addedTag = callApi("content/addTag",{
"tagDescription":tagName,
"tagType":0
},token);
let tagId = addedTag.modifiedList[0].id;
//step 2: find/search for a Discover item called "sales figures"
let dataDiscovery = callApi("content/findContentItem",{
"searchString": "sales figures",
"filterTypes": [3],
"searchMatchType": 2,
"searchRootFolderType":0
},token // admin token generated above
);
let itemId = dataDiscovery[0].id;
//step 3: bind the new tag to this report
let itemIds = callApi("content/addTagToItem ",{
"itemId":itemId,
"tagId":tagId
},token);
//step 4: get a specific tag object using its tag id
let getTag = callApi("content/getTagData",tagId ,token)
//step 5: remove the tag from a specific content item
let removeTagFromItem = callApi("content/removeTagFromItem",{
"itemId":itemId,
"tagId":tagId
},token);
//step 6: delete the tag
let deleteTag = callApi("content/deleteTag",tagId, token);
//step 7: permanently delete the content item
let purgeContentItems = callApi("content/purgeContentItems",[folderCreation.modifiedList[0].id],token);
// ##### optional generic logging method for debugging ##############
function log(msg){
document.write(msg);
console.log(msg);
}
// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
var xhttp = new XMLHttpRequest();
xhttp.open("POST", pyramidURL+path, false);
xhttp.setRequestHeader("paToken",token)
xhttp.send(JSON.stringify(data));
if(parseResult){
return JSON.parse(xhttp.responseText);
}else{
return xhttp.responseText;
}
}
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/content/getTagData" \
-d ''
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ContentServiceApi;
import java.util.*;
import java.time.*;
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 tagId parameter object for the call
String tagId = tagId_example; // Create the input object for the operation, type: String
try {
TagData result = apiInstance.getTagData(tagId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#getTagData");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const tagId = tagId_example; // {String}
api.getTagData(tagId).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 getTagDataExample
{
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 tagId parameter object for the call
var tagId = tagId_example; // Create the input object for the operation, type: String |
try {
// Returns the Tag with its metadata
TagData result = apiInstance.getTagData(tagId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.getTagData: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ContentServiceApi
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 = ContentServiceApi(api_client)
# Initialize the tagId parameter object for the call
tagId = tagId_example # String |
try:
# Returns the Tag with its metadata
api_response = api_instance.get_tag_data(tagId)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->getTagData: %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\ContentServiceApi();
$tagId = tagId_example; // String |
try {
$result = $api_instance->getTagData($tagId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->getTagData: ', $e->getMessage(), PHP_EOL;
}
?>