Search for Content Items
{ findContentItem }
Returns a list of content items based on search criteria
Method
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
- Basic
Input Parameters
Name
searchParams
Object Type
Description
The content search object for specifying search criteria to be used in content searches.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
Pyramid Content item object.. Note that the response is returned as a list of items of this object type.
Notes
When setting criteria, mark the search as 'advanced' to use the extra criteria conditions, If you add a searchString by tenant name - search will be optimized.
Examples
This example demonstrates how to manage content items in Pyramid.
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 the default tenant ID
let defaultTenant=callApi("access/getDefaultTenant",{
},token // admin token generated above
);
//step 3: return the ID of the public root folder for the tenant from step 2
let tenentPublicFolder = callApi("content/getTenantPublicOrGroupFolder",{
"validRootFolderType": 1,//the public folder of the default tenant
"tenantId": defaultTenant
},token // admin token generated from step 1 above
);
//step 4: add a new folder to the public folder from step 3
let folderCreation = callApi("content/createNewFolder",{
"parentFolderId": tenentPublicFolder.id,
"folderName": "new folder"
},token);
let folderId=folderCreation.modifiedList[0].id;
//step 5: find roles
let findRole = callApi("access/findRoles",{
"searchValue": "role1",
"searchMatchType": 2//SearchMatchType.Equals
},token);
let roleId=findRole[0].roleId;
log("found role with id= "+ roleId);
//step 6:add the role we found in step 5 to the folder we created (folderId) in step 4
let addRoleToFolder= callApi("content/addRoleToItem",{
"itemId": folderId,
"roleId": roleId//SearchMatchType.Equals
},token);
//step 7: read in a Pyramid Import/Export ('PIE') file
let file="http://myOtherSite.com/Sample.pie";
let pieFile=readPieFile(file);
//step 8: import the PIT file into the folder from step 4
let importContent = callApi("content/importContent",{
"rootFolderId": folderId, //from step 4
"fileZippedData": pieFile, //the file's content from step 7
"clashDefaultOption":1,//ClashDefaultOption.REPLACE_FILE like default
"rolesAssignmentType":3//RoleAssignmentType.ForceParentFolderRoles take roles from parent folder
},token);
let itemId=Object.keys(importContent.importDscMap)[0];
//step 9: optional, search for the item we just imported, it's id is itemId
let findContentItem = callApi("content/findContentItem",{
"searchString":"import",
"filterTypes":[3],//ContentTypeObject.DataDiscoveryv
"searchMatchType":2,//SearchMatchType.Equals
"searchRootFolderType":1//SearchRootFolderType.Public
},token);
//step 10: check if you need to run datasource changer
// (since the datasource that created this report dosen't exists on this server)
if(importContent.importDscMap[itemId][0].needsToPerformDsc){
// step 10A: get item's data source connection
let correntConnectionStringId=importContent.importDscMap[itemId][0].connectionStringProperties.id
//step 10B: run the data source changer on the items
let changedDatasource = callApi("dataSources/changeDataSource",{
"fromConnId":correntConnectionStringId,
"toConnId":"55ff277a-53ff-4c39-8f15-5651f1026a2d",//retrive this id using 'getAllConnectionStrings'
"itemId":itemId
},token);
}
//step 11: copying the imported item to the tenant root folder
let copyItems = callApi("content/copyItems",{
"itemsForMove":[itemId],
"destinationFolder":tenentPublicFolder.id
},token);
//step 12: remove roles from the folder but not from the item
let removeRoleFromCreatedFolder= callApi("content/removeRolesFromItem",{
"itemId": folderId,
"roleIds": [roleId]
},token);
//step 13: hard delete the folder (permanently)
let folderDeletion = callApi("content/purgeContentItems",[
folderCreation.modifiedList[0].id
],token);
//step 14: soft-delete the items
let itemSoftDeletion = callApi("content/deleteItems",[
copyItems.modifiedList[0].id
],token);
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;
}
}
//example function to read in the contents of a 'PIE' file that contains
//exported Pyramid content.
function readPieFile(file){
var rawFile = new XMLHttpRequest();
rawFile.open("GET", file, false);
rawFile.send(null);
rawFile.onreadystatechange = function () {
if (request.readyState === 4 && request.status === 200) {
return request.responseText;
}
}
}
This example demonstrates how to run queries and slicers (parameters) programmatically to extract results.
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!"
},token,false);
//step 2: find a parameter definition called "param x". Parameters are saved items to drive slicers
let calculation = callApi("content/findContentItem",{
"searchString": "param x",
"filterTypes": [2],
"searchMatchType": 2,
"searchRootFolderType":0
},token // admin token generated above
);
let paramId = calculation[0].id;
//step 3: get the parameter's elements
let parameterElements = callApi("analytics/getParameterElements",paramId,token);
let members = parameterElements.members // list for members
console.log(members);
//step 4: find a data discovery called "report x"
let dataDiscovery = callApi("content/findContentItem",{
"searchString": "report x",
"filterTypes": [3],
"searchMatchType": 2,
"searchRootFolderType":0
},token // admin token generated above
);
let reportId = dataDiscovery[0].id;
//step 5: extract the report results as JSON that have been filtered by the first member of the parameter found in step 3
let queryResult = callApi("analytics/extractQueryResult",{
"itemId":reportId,
"exportType":0, //JSON
"exportOptions": {},
"externalParameters": {
"reportFilters" : [
{
"value": members[0].uniqueName
}
]
}
},token);
console.log(JSON.parse(queryResult));
// ##### 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.
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/findContentItem" \
-d '{
"server" : "server",
"dataBase" : "dataBase",
"folderPathToSearch" : "folderPathToSearch",
"isAdvancedSearch" : true,
"startModifiedDate" : "2000-01-23T04:56:07.000+00:00",
"searchString" : "searchString",
"endModifiedDate" : "2000-01-23T04:56:07.000+00:00",
"startCreatedDate" : "2000-01-23T04:56:07.000+00:00",
"model" : "model",
"endCreatedDate" : "2000-01-23T04:56:07.000+00:00",
"filterTypes" : [ null, null ],
"allowFallback" : true
}'
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 searchParams parameter object for the call
ContentSearchParamsObject searchParams = ; // Create the input object for the operation, type: ContentSearchParamsObject
try {
// "array[PyramidContentItem]" is only psaudo-code to symbolize list of type and not the actual usage
array[PyramidContentItem] result = apiInstance.findContentItem(searchParams);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#findContentItem");
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 searchParams = ; // {ContentSearchParamsObject}
api.findContentItem(searchParams).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 findContentItemExample
{
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 searchParams parameter object for the call
var searchParams = new ContentSearchParamsObject(); // ContentSearchParamsObject |
try {
// Returns a list of content items based on search criteria
// "array[PyramidContentItem]" is only psaudo-code to symbolize array of type and not the actual usage
array[PyramidContentItem] result = apiInstance.findContentItem(searchParams);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.findContentItem: " + 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 searchParams parameter object for the call
searchParams = # ContentSearchParamsObject |
try:
# Returns a list of content items based on search criteria
api_response = api_instance.find_content_item(searchParams)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->findContentItem: %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();
$searchParams = ; // ContentSearchParamsObject |
try {
$result = $api_instance->findContentItem($searchParams);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->findContentItem: ', $e->getMessage(), PHP_EOL;
}
?>