Get Help page URL by help ID
Returns the URL to access the help page, which is identified by a numerical help ID.
The help ID and the corresponding page are set in the application.yml configuration file using a configuration item named help.HELP_ID, where HELP_ID is the help ID. The following example shows a configuration item with the help ID 1001.
<configitem name="help.1001">
<comments>Book list</comments>
<value>/help/Choosing_a_Technical_Manual.htm</value>
</configitem>
Example API call
/lcapi?target=tools&action=show_help&location=1001
Parameters
| Parameter | Description |
|---|---|
target | tools |
action | show_help |
location | The requested help ID |
Returns
- On success
-
<RESULT> <URL>/lcapi/help/Choosing_a_Technical_Manual.htm</URL> </RESULT> - On failure
- Returns nothing