Get Help Link

Obtain an URL to help documentation. By default, an URL to the main help page is returned.

GET https://instance.securid.com/aveksa/command.submit?cmd=getHelpLink

Request

Parameters

command	getHelpLink
format	properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc. json - Useful format for parsing into javascript or other languages. See www.json.org for details.
help-id	The id of the help page to return. If this parameter is not present, or if it does not map to a valid help page, the main help page will be returned.

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Response

Parameters

type	Executed command name
help-link	The URL to the help page.

Examples

Request

Curl

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=getHelpLink&format=json" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests, json

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "getHelpLink",
    "format": "json"
}

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    data = response.json()
    help_link = data.get("data", {}).get("help-link")
    if help_link:
        print(help_link)
    else:
        print("Help link not found in the response.")
else:
    print(f"Request failed with status code {response.status_code}")

Node.js

const axios = require('axios');

const url = "https://instance.securid.com/aveksa/command.submit";

const params = {
    cmd: "getHelpLink",
    format: "json"
};

const headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            const data = response.data;
            const help_link = data.data?.["help-link"];
            if (help_link) {
                console.log(help_link);
            } else {
                console.log("Help link not found in the response.");
            }
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error);
    });

Response

200

{
    "data": {
        "type": "getHelpLink",
        "help-link": "https://instance.securid.com/aveksa/help/Launch_Help.htm#cshid=1"
    }
}