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
▲ 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
buildworkflow
Syntax
buildworkflow ($workflow_data)
Input parameters
- $workflow_data ... workflow [XML]
Output
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
$hcms_lang_codepage
$hcms_lang
$lang
Output
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
$hcms_lang_codepage
$hcms_lang
$lang
Output
getworkflowitem
Syntax
getworkflowitem ($site, $workflow_file, $workflow, $user)
Input parameters
- $site ... publication name [string]
- $workflow_file ... location [string]
- $workflow ... object name [string]
- $user ... workflow file name [string]
global input parameters
- $mgmt_config
$hcms_lang
$lang
Output
- workflow item [XML-string]
getworkflowstatus
Description
Reads the workflow status information of an object.
Syntax
getworkflowstatus ($site, $location, $page, $templatefile="", $contentfile="")
Input parameters
- $site ... publication name [string]
- $location ... location path [string]
- $page ... object name [string]
- $templatefile ... template file name [string] (optional)
- $contentfile ... container file name [string] (optional)
global input parameters
- $mgmt_config
$publ_config
$hcms_charset
$hcms_lang
$lang
$user
Output
- workflow status view / false