Get dictionary group

Returns dictionary group with the specified ID.

Request

HTTP Request

GET /node/api/dictionary-groups/:id

Path parameters

Parameter Type Description

id

String
required

ID of the dictionary group.

Request body

Request body is empty.

Response

Returns dictionary group with the specified ID. Response can contain the following fields:

Field Type Description

id

String

ID of the dictionary group.

name

String

Name of the dictionary group.

description

String

Description of the dictionary group.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
dict_id=<...>
url=https://$saymon_hostname/node/api/dictionary-groups/$dict_id

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let dictId = <...>
let path = "/node/api/dictionary-groups/" + dictId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));
const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let dictId = <...>
let path = "/node/api/dictionary-groups/" + dictId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
dict_id = <...>
url = "https://" + saymon_hostname + "/node/api/dictionary-groups/" + dict_id

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response

{
    "id": "66e1696af85fc81ba1c9cefd",
    "name": "Example Dictionary",
    "content": "{\"key1\":[\"value1-1\",\"value2-1\"],\"key2\":[\"value1-2\",\"value2-2\"],\"key3\":[\"value1-3\",\"value2-3\"]}",
    "description": "This is a dictionary shown in the REST API documentation",
    "contentType": "object"
}