Export Content to a PIE file
{ exportContent }
Export content items into a PIE archive file.
Method
/API3/content/exportContent
- Enterprise Admin
Input Parameters
Name
exportContentData
Object Type
Description
The object representing the details for which items to export with two booleans.
Output Response
Successful Result Code
200
Response Type
string
Description of Response Type
successful operation
Notes
PIE files can contain any content items selected for export - including folders. Certain content items will include constituent (child) items as well in the export.
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/exportContent" \
-d '{
"itemsToExport" : [ "itemsToExport", "itemsToExport" ],
"maintainFolderStructure" : true,
"dontBringRelatedContent" : 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 exportContentData parameter object for the call
ExportContentApiData exportContentData = ; // Create the input object for the operation, type: ExportContentApiData
try {
String result = apiInstance.exportContent(exportContentData);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#exportContent");
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 exportContentData = ; // {ExportContentApiData}
api.exportContent(exportContentData).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 exportContentExample
{
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 exportContentData parameter object for the call
var exportContentData = new ExportContentApiData(); // ExportContentApiData |
try {
// Export content items into a PIE archive file.
string result = apiInstance.exportContent(exportContentData);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.exportContent: " + 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 exportContentData parameter object for the call
exportContentData = # ExportContentApiData |
try:
# Export content items into a PIE archive file.
api_response = api_instance.export_content(exportContentData)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->exportContent: %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();
$exportContentData = ; // ExportContentApiData |
try {
$result = $api_instance->exportContent($exportContentData);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->exportContent: ', $e->getMessage(), PHP_EOL;
}
?>