Получить словарь

Возвращает словарь с указанным ID.

Запрос

HTTP Запрос

GET /node/api/objects/dictionaries/:id

Параметры пути

Параметр Тип Описание

id

String
обязательно

ID словаря.

Тело запроса

Тело запроса пустое.

Ответ

Возвращает словарь с указанным ID.

Модель словаря
Поле Тип Описание

columns

Object

Названия столбцов (ключа и значений) словаря. Присутствует только словарях с именованными столбцами.

Определяется как объект JSON следующего вида:

"columns": {
    "0": {
        "name": "название ключа"
    },
    "1": {
        "name": "название первого значения"
    },
    "2": {
        "name": "название второго значения"
    },
    ...
},
Значения в объекте можно пропускать и оставлять столбцы неназванными.

content

String

Пары ключ-значение, где ключ – реальное значение метрики, а значение – отображаемое пользователю в виджетах.

contentType

String

Строка, которая содержит тип значения словаря. В текущей реализации, всегда содержит object.

comment

String

Пользовательский комментарий к словарю.

description

String

Описание словаря.

group

String

ID группы, к которой принадлежит словарь.

id

String

Идентификатор словаря.

key_auto_gen

Boolean

Включить автоматическую генерация ключей. Если true – система будет генерировать ключи в формате UUIDv4 для новых записей.

name

String

Название словаря.

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
dict_id=<...>
url=https://$saymon_hostname/node/api/objects/dictionaries/$dict_id

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let dictId = <...>
let path = "/node/api/objects/dictionaries/" + 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/objects/dictionaries/" + 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/objects/dictionaries/" + dict_id

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

Ответ

{
    "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"
}