Find Content Items By Tag Caption
{ findItemsByTagName }
Returns a list of content items based on tag caption.
Method
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
- Basic
Input Parameters
Name
tag
Type
string
Description
The tag caption to search
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
A generic object used to contain ID of item.. Note that the response is returned as a list of items of this object type.
Notes
For this to be effective, content tags need to be set on items in the content system by users.
Examples
![Closed](../../../../../../../../Skins/Default/Stylesheets/Images/transparent.gif)
This example demonstrates how to find item's in the content manager using content tags. The results are then used to create dynamic embedding on a host page.
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);
log("got token "+ token );
// step 2: get all content items in the content system that have been tagged with "embed"
var tagName = "embed";
let itemIds = callApi("content/findItemsByTagName", tagName, token);
// step 3: for each item in the search result list, embed it on the host page
embedMultiple(itemIds.data);
// ### embed function
function embedMultiple(ids) {
for (var i = 0; i < ids.length; i++) {
var div = document.createElement("DIV");
div.id = ids[i];
div.style = "width: 1000px; height: 600px; border: 1ps solid blue;";
document.getElementById("mainContainer").appendChild(div);
//use the Pyramid 'embed' method from the embed library
//to add live content to each generated DIV elemt
pyramid.embed(div, {
id: ids[i],
host: "http://mysite.com",
contentType: "storyboard"
});
}
}
// ##### optional generic login 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.
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/findItemsByTagName" \
-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 tag parameter object for the call
String tag = tag_example; // Create the input object for the operation, type: String
try {
// "array[ItemId]" is only psaudo-code to symbolize list of type and not the actual usage
array[ItemId] result = apiInstance.findItemsByTagName(tag);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#findItemsByTagName");
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 opts = {
'tag': tag_example // {String}
};
api.findItemsByTagName(opts).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 findItemsByTagNameExample
{
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 tag parameter object for the call
var tag = tag_example; // Create the input object for the operation, type: String | (optional)
try {
// Returns a list of content items based on tag caption.
// "array[ItemId]" is only psaudo-code to symbolize array of type and not the actual usage
array[ItemId] result = apiInstance.findItemsByTagName(tag);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.findItemsByTagName: " + 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 tag parameter object for the call
tag = tag_example # String | (optional)
try:
# Returns a list of content items based on tag caption.
api_response = api_instance.find_items_by_tag_name(tag=tag)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->findItemsByTagName: %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();
$tag = tag_example; // String |
try {
$result = $api_instance->findItemsByTagName($tag);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->findItemsByTagName: ', $e->getMessage(), PHP_EOL;
}
?>