Search for Content Items
{ getItem }
Returns a list of content items based on search criteria
Method
/API3/content/getItem
- Enterprise Admin
- Domain Admin
- Pro
- Analyst
- Viewer
- Basic
Input Parameters
Name
searchParams
Object Type
Description
The search configuration for specifying the criteria to be used
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
Enter Path with the name of the item, filter types and root folder type. Output will be this items.
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/getItem" \
-d '{
"itemPath" : "itemPath"
}'
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
GetItemParamsObject searchParams = ; // Create the input object for the operation, type: GetItemParamsObject
try {
// "array[PyramidContentItem]" is only psaudo-code to symbolize list of type and not the actual usage
array[PyramidContentItem] result = apiInstance.getItem(searchParams);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#getItem");
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 = ; // {GetItemParamsObject}
api.getItem(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 getItemExample
{
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 GetItemParamsObject(); // GetItemParamsObject |
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.getItem(searchParams);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.getItem: " + 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 = # GetItemParamsObject |
try:
# Returns a list of content items based on search criteria
api_response = api_instance.get_item(searchParams)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->getItem: %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 = ; // GetItemParamsObject |
try {
$result = $api_instance->getItem($searchParams);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->getItem: ', $e->getMessage(), PHP_EOL;
}
?>