API Documentation

API Documentation / Wiki

The following pages provide an overview about all functions of the API (Application Programming Interface) of the hyper Content & Digital Asset Management Server.
Please note, that you might usually only require few functions for the development of Plugins, template functions like navigation, sitemap and so on. Please read the Template Designers Guide and Programers Guide for a better insight.
The API is primarily used for the implementation of standalone applications that leverage the capabilities of the hyper Content & Digital Asset Management Server. The API is not to be confused with the OpenAPI, which is based on a SOA (Service Oriented Architecture), and is not part of the Free Edition.

For Questions & Answers please visit the Google Group.

hyperCMS API Function Reference

  1. Main API Functions
  2. Get API Functions
  3. Set API Functions
  4. Connect API Functions
  5. Security API Functions
  6. Media API Functions
  7. Metadata API Functions
  8. Link API Functions
  9. Plugin API Functions
  10. User Interface API Functions
  11. Template Engine API Functions
  12. XML API Functions
  13. Report API Functions
  14. Project API Functions
  15. Task API Functions
  16. Workflow API Functions
  17. Cloud Storage API Functions
  18. Import/Export API Functions

Import/Export API Functions

exportobjects


Description
Executes the export job.

Syntax
exportobjects ()

Input parameters

global input parameters
  • $mgmt_config

Output
  • true / false


importobjects


Description
Executes the import job.

Syntax
importobjects ()

Input parameters

global input parameters
  • $mgmt_config

Output
  • true / false


importmediafiles


Description
This function imports all directories and files from the import directory to location.

Syntax
importmediafiles ($importdir, $location, $createfolders=false, $leavefiles=false, $deletefiles=false, $report=true, $user="sys")

Input parameters
  • $importdir ...
  • $location
  • $createfolders
  • $leavefiles
  • $deletefiles
  • $report
  • $user

global input parameters
  • $mgmt_config

Output
  • true/false


importxmlfiles


Description
Import of content and media files based on the XML import schema.

Syntax
importxmlfiles ($importdir, $createfolders=false, $ignoremissinglinks=false, $leavefiles=false, $deletefiles=false, $report=true, $user="sys")

Input parameters
  • $importdir ... path of the import directory [string]
  • $createfolders ... create folder [boolean] (optional)
  • $ignoremissinglinks ... ignore or keep links to missing objects [boolean] (optional)
  • $leavefiles ... leave the files in the import directory and create symbolic link to the file [boolean] (optional)
  • $deletefiles ... delete files after successful import [boolean] (optional)
  • $report ... print report [boolean] (optional)
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false


calculatedate


Syntax
calculatedate ($days)

Input parameters
  • $days ... number of days [integer]

Output
  • date based on number of days in the past from today


exportxmlfiles


Description
Export of content and media files based on the XMLexport schema.

Syntax
exportxmlfiles ($location, $object="", $exportdir="", $recursive=false, $preserve=false, $symlink=false, $delete=false, $createdays=0, $editdays=0, $accessdays=0, $filesize=0, $contentrules="", $report=true, $user="sys")

Input parameters
  • $location ... location [string]
  • $object ... object name [string] (optional)
  • $exportdir ... path of the export directory or FTP server path [string]
  • $recursive ... export all items in subfolders recursively [boolean] (optional)
  • $preserve ... preserve container ID [boolean] (optional)
  • $symlink ... export only the media files and use a symbolic link to the file [boolean] (optional)
  • $delete ... delete files after successful export [boolean] (optional)
  • $createdays ... age in days after creation of the object [integer] (optional)
  • $editdays ... age in days after last modification of the object [integer] (optional)
  • $accessdays ... age in days after last access of the object [integer] (optional)
  • $filesize ... minimum file size of the asset in MB [integer] (optional)
  • $contentrules ... content rules/conditions for text content based on SQL Syntax [string]
  • $report ... print report [boolean] (optional)
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false


This website uses cookies to ensure you get the best experience on our website. More info