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

Project API Functions

createproject


Description
This function creates a new project.

Syntax
createproject ($subproject_id=0, $object_id="", $owner="", $projectname="", $description="")

Input parameters
  • $subproject_id ... ID of main project (only if the project is a subproject) [integer]
  • $object_id ... object ID or path to object [string] (optional)
  • $owner ... user name of sub/project owner [string]
  • $projectname ... project name [string]
  • $description ... project description [string] (optional)

global input parameters
  • $mgmt_config
  • $user
  • $hcms_lang_codepage
  • $hcms_lang
  • $lang

Output
  • result array


editproject


Description
This function saves data of an existing project.
Use *Leave* as input if a value should not be changed.

Syntax
editproject ($project_id, $subproject_id="*Leave*", $object_id="*Leave*", $owner="*Leave*", $projectname="*Leave*", $description="*Leave*")

Input parameters
  • $project_id ... project ID [integer]
  • $subproject_id ... ID of main project (only if project is a subproject) [integer or string]
  • $object_id ... object ID or path to object [string] (optional)
  • $owner ... user name of sub/project owner [string] (optional)
  • $projectname ... project name [string] (optional)
  • $description ... project description [string] (optional)

global input parameters
  • $mgmt_config
  • $user
  • $hcms_lang_codepage
  • $hcms_lang
  • $lang

Output
  • result array


deleteproject


Description
This function removes projects.

Syntax
deleteproject ($project_id)

Input parameters
  • $project_id ... project ID or array of project IDs to be deleted [string or array]

global input parameters
  • $mgmt_config
  • $user
  • $hcms_lang
  • $lang

Output
  • result array


getprojectstructure


Description
This function creates an associative array presenting the project structure (project -> subprojects -> tasks).

Syntax
getprojectstructure ($project_id, $owner="")

Input parameters
  • $project_id ... project ID [integer]
  • $owner ... projects for specific user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • associative result array / false


showprojectrecord


Description
This function creates a table row for the projects presentation.

Syntax
showprojectrecord ($project_record, $masterproject_id)

Input parameters
  • $project_record ... project record as array (project/subproject/task) [array]
  • $masterproject_id ... ID of master project [integer]

global input parameters
  • $mgmt_config
  • $hcms_lang
  • $lang
  • $siteaccess
  • $user_array

Output
  • html presentation of the record / false


showganttchart


Description
This function creates the Google Chart Code for a Gantt chart. The Google Chart API need to be loaded first.

Syntax
showganttchart ($title="", $task_title="", $task_value="", $resource_title="", $resource_value="", $start_title="", $start_value="", $end_title="", $end_value="", $status_title="", $status_value="", $data_array=array(), $width="100%", $height="100%", $id="hcmsTimelineChart", $suffix="", $loadAPI=true)

Input parameters
  • $title ... chart title [string]
  • $task_title ... task title [string]
  • $task_value ... task array key name holding the values [array]
  • $resource_title ... resouce title [string] (optional)
  • $resource_value ... resource array key name holding the values [string] (optional)
  • $start_title ... task start date title [string]
  • $start_value ... task start date array key name holding the values [string]
  • $end_title ... task finish date title [string]
  • $end_value ... task finish date array key name holding the values [string]
  • $status_title ... work status title [string] (optional)
  • $status_value ... work status array key name holding the values [string] (optional)
  • $data_array ... assoz. data array [array]
  • $width ... chart width [string] (optional)
  • $height ... chart height [string] (optional)
  • $id ... ID of chart [string] (optional)
  • $suffix ... function name suffix [string] (optional)
  • $loadAPI ... load Google Chart API [boolean] (optional)

global input parameters
  • $mgmt_config
  • $hcms_lang
  • $lang

Output
  • Google Chart code / false


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