Navigation :

Help

The help API is used to get HTML segments for the user guide.

GET /api/help/:section/:page

Parameter	Example	Description
`section`	`embedded`	[URL parameter], [Required] The section of help we are obtaining information from.
`page`	`index`	[URL parameter], [Required] The page of the help section we are obtaining information for.

Response Content

The help API returns the coresponding html segment for the help documenetation.

Examples

Request:

curl 'http://localhost/jarvis-agent/n2fe/api/help/embedded/index'  -H 'Cookie: N2FE_CGISESSID=4876c530f3d7252330a95ea51007f252'

Response:

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">

        <meta name="author" content="N-Squared Software (NZ), Ltd.">

        <link rel="shortcut icon" href="./img/favicon.ico">

        <title>N-Squared Flow Editor - User Guide</title>

        ...
    </head>
    <body>

        <div class="navbar navbar-default navbar-fixed-top" role="navigation">
    <div class="container">

        <!-- Collapsed navigation -->
        <div class="navbar-header">
            <!-- Expander button -->
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
                <span class="sr-only">Toggle navigation</span>
        ...

    </body>

    ...