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
- Main API Functions
- Get API Functions
- Set API Functions
- Connect API Functions
- Security API Functions
- Media API Functions
- Metadata API Functions
- Link API Functions
- Plugin API Functions
- User Interface API Functions
- Template Engine API Functions
- XML API Functions
- Report API Functions
- Project API Functions
- Task API Functions
- Workflow API Functions
- Cloud Storage API Functions
- Import/Export API Functions
▲ Import/Export API Functions
exportobjects
Description
Executes the export job.
Syntax
exportobjects ()
Input parameters
global input parameters
Output
importobjects
Description
Executes the import job.
Syntax
importobjects ()
Input parameters
global input parameters
Output
reimportmediafiles
Description
This function reimports only media files from the import directory to the selected publication if they have been exported before. The existing symbolic links will be replaced by the media file with the same name.
Syntax
reimportmediafiles ($importdir, $site, $report=true, $user="sys", $set_headers=false)
Input parameters
- $importdir ...
- $site
- $report
- $user
- $set_headers
global input parameters
Output
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", $set_headers=false)
Input parameters
- $importdir ...
- $location
- $createfolders
- $leavefiles
- $deletefiles
- $report
- $user
- $set_headers
global input parameters
Output
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", $set_headers=false)
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)
- $set_headers ... set PHP ini and headers for output buffering [bollean] (optional)
global input parameters
Output
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", $set_headers=false)
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)
- $set_headers ... set PHP ini and headers for output buffering [bollean] (optional)
global input parameters
Output