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

Task API Functions

createtask


Description
Creates a new user task and send optional e-mail to user.
Since verion 5.8.4 the data will be stored in RDBMS instead of XML files.

Syntax
createtask ($site, $from_user="", $from_email="", $to_user="", $to_email="", $startdate="", $finishdate="", $category="", $object_id="", $taskname="", $message="", $sendmail=true, $priority="low", $project_id=0, $planned="")

Input parameters
  • $site ... publication name [string] (optional)
  • $from_user ... from_user name [string]
  • $from_email ... from_email [email-address] (optional)
  • $to_user ... to_user name [string]
  • $to_email ... to_email [email-address] (optional)
  • $startdate ... start date [yyyy-mm-dd] (optional)
  • $finishdate ... finish date [yyyy-mm-dd] (optional)
  • $category ... category [link, user, workflow] (optional)
  • $object_id ... object ID or object path [string]
  • $taskname ... task name [string]
  • $message ... message [string] (optional)
  • $sendmail ... sendmail [boolean]
  • $priority ... priority [high, medium, low] (optional)
  • $project_id ... project/subproject ID if the task should be assigned to a project [integer] (optional)
  • $planned ... planned effort in taskunit [integer] (optional)

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

Output
  • result array


edittask


Description
Saves data of a user task and send optional e-mail to user.
Since verion 5.8.4 the data will be stored in RDBMS instead of XML files.
Use *Leave* as input if a value should not be changed.

Syntax
edittask ($task_id, $object_id="*Leave*", $to_user="*Leave*", $startdate="*Leave*", $finishdate="*Leave*", $taskname="*Leave*", $message="*Leave*", $sendmail=true, $priority="*Leave*", $status="*Leave*", $planned="*Leave*", $actual="*Leave*", $project_id=0)

Input parameters
  • $task_id ... task ID [integer]
  • $object_id ... object ID or path to object [integer or string] (optional)
  • $to_user ... to_user name [string] (optional)
  • $startdate ... start date [yyyy-mm-dd] (optional)
  • $finishdate ... finish date [yyyy-mm-dd] (optional)
  • $taskname ... name of task [string] (optional)
  • $message ... task message/description [string] (optional)
  • $sendmail ... sendmail [true/false]
  • $priority ... priority [high, medium, low] (optional)
  • $status ... status in percent [0-100] (optional)
  • $planned ... planned effort in taskunit [float] (optional)
  • $actual ... actual effort in taskunit [float] (optional)
  • $project_id ... project/subproject ID the task belongs to [integer] (optional)

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

Output
  • result array


deletetask


Description
Deletes user tasks.

Syntax
deletetask ($task_id)

Input parameters
  • $task_id ... task ID or array of task IDs to be deleted [integer]

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

Output
  • true/false


tasknotification


Description
Sends e-mail notifications to users if a task starts or ends on the given date.

Syntax
tasknotification ($date)

Input parameters
  • $date ... date [yyyy-mm-dd]

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

Output
  • true/false


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