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

Workflow API Functions

deleteworkflow


Description
This function deletes a workflow.

Syntax
deleteworkflow ($site, $wf_name, $cat)

Input parameters
  • $site ... publication name [string]
  • $wf_name ... worfklow name [string]
  • $cat ... category [man, script]

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

Output
  • result array


buildworkflow


Syntax
buildworkflow ($workflow_data)

Input parameters
  • $workflow_data ... workflow [XML]

Output
  • workflow items as array


workflowaccept


Syntax
workflowaccept ($site, $location, $object, $workflow, $item_id, $exec_user, $task_message="", $sendmail=true, $task_priority="medium", $task_start="", $task_end="")

Input parameters
  • $site ... publication name [string]
  • $location ... location name [string]
  • $object ... object name [string]
  • $workflow ... workflow [XML-string]
  • $item_id ... item id [string]
  • $exec_user ... user name of executing user [string]
  • $task_message ... task message [string] (optional)
  • $sendmail ... sendmail [boolean] (optional)
  • $task_priority ... task priority [high, medium, low] (optional)
  • $task_start ... task start date [date] (optional)
  • $task_end ... task end date [date] (optional)

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

Output
  • workflow [XML-string] / false


acceptobject


Description
Accepts an object that is managed by a workflow.

Syntax
acceptobject ($site, $location, $object, $item_id, $exec_user, $task_message="", $sendmail=true, $task_priority="medium", $task_start="", $task_end="")

Input parameters
  • $site ... publication name [string]
  • $location ... location name [string]
  • $object ... object name [string]
  • $item_id ... workflow item id [string]
  • $exec_user ... user name of executing user [string]
  • $task_message ... task message [string] (optional)
  • $sendmail ... sendmail [boolean] (optional)
  • $task_priority ... task priority [high, medium, low] (optional)
  • $task_start ... task start date [date] (optional)
  • $task_end ... task end date [date] (optional)

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

Output
  • result array


workflowreject


Description
Rejects an object that is managed by a workflow.

Syntax
workflowreject ($site, $location, $object, $workflow, $item_id, $exec_user, $task_message="", $sendmail=true, $task_priority="medium", $task_start="", $task_end="")

Input parameters
  • $site ... publication name [string]
  • $location ... location name [string]
  • $object ... object name [string]
  • $workflow ... workflow [XML-string]
  • $item_id ... workflow item id [string]
  • $exec_user ... user name of executing user [string]
  • $task_message ... task message [string] (optional)
  • $sendmail ... send mail [boolean] (optional)
  • $task_priority ... task priority [high, medium, low] (optional)
  • $task_start ... task start date [date] (optional)
  • $task_end ... task end date [date] (optional)

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

Output
  • workflow [XML-string] / false


rejectobject


Description
Rejects an object that is managed by a workflow.

Syntax
rejectobject ($site, $location, $object, $item_id, $exec_user, $task_message="", $sendmail=true, $task_priority="medium", $task_start="", $task_end="")

Input parameters
  • $site ... publication name [string]
  • $location ... location name [string]
  • $object ... object name [string]
  • $item_id ... workflow item id [string]
  • $exec_user ... user name of executing user [string]
  • $task_message ... task message [string] (optional)
  • $sendmail ... send mail [boolean] (optional)
  • $task_priority ... task priority [high, medium, low]
  • $task_start ... task start date [date] (optional)
  • $task_end ... task end date [date] (optional)

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

Output
  • result array


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