Import Content from a PIE file

Import content items stored in a Pyramid PIE archive file.

From Pyramid 2025.02 onwards, hardened security infrastructure has necessitated a change to the internal format of PIE and PAT files. If you are importing an older PIE file (exported from Pyramid 2018 or Pyramid 2020 versions) and receive an error “Unknown file format”, the PIE file needs to be upgraded to the new format before importing.

See PIE and PAT export file converter for more details.

Method

/API3/content/importContent

  • API Section: /API3/content
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer

Method Signature

Input Parameters

Name

pieApiObject

Object Type

Description

The object representing the details for where to import a PIE file of content.

Output Response

Successful Result Code

200

Response Type

Description of Response Type

The import content items result object from importing content into the system.

Notes

PIE files can contain any content items previously exported - including folders. Certain content items will include constituent (child) items as well. The response from the method - ImportApiResultObject - a map of the item id that was exported associated to a list of ConnStringDscApiObject, where each object holds a connection string property and a flag that indicated whether a data source change is required for the item.It is recommended that this API would not get executed in parallel.

Examples

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/importContent" \
 -d '{
  "fileZippedData" : "fileZippedData",
  "roleIds" : [ "roleIds", "roleIds" ],
  "rootFolderId" : "rootFolderId"
}'
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 pieApiObject parameter object for the call
        PieApiObject pieApiObject = ; // Create the input object for the operation, type: PieApiObject 

        try {
            ImportApiResultObject result = apiInstance.importContent(pieApiObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentServiceApi#importContent");
            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 pieApiObject = ; // {PieApiObject} 

api.importContent(pieApiObject).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 importContentExample
{
    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 pieApiObject parameter object for the call
        var pieApiObject = new PieApiObject(); // PieApiObject | 

        try {
            // Import content items stored in a Pyramid PIE archive file.
            ImportApiResultObject result = apiInstance.importContent(pieApiObject);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling ContentServiceApi.importContent: " + 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 pieApiObject parameter object for the call
    pieApiObject =  # PieApiObject | 

    try:
        # Import content items stored in a Pyramid PIE archive file.
        api_response = api_instance.import_content(pieApiObject)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentServiceApi->importContent: %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();
$pieApiObject = ; // PieApiObject | 

try {
    $result = $api_instance->importContent($pieApiObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentServiceApi->importContent: ', $e->getMessage(), PHP_EOL;
}
?>