Получить все словари
Возвращает массив всех словарей в системе.
Запрос
HTTP Запрос
text
GET /node/api/dictionariesПараметры пути
Параметры не требуются.
Тело запроса
Тело запроса пустое.
Ответ
Этот запрос возвращает массив всех словарей в системе.
| Поле | Тип | Описание | ||
|---|---|---|---|---|
| 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
bash
login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/dictionaries
curl -X GET $url -u $login:$passwordjavascript
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/dictionaries";
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));javascript
const http = require("http");
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/dictionaries";
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();python
import requests
login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/dictionaries"
response = requests.request("GET", url, auth=(login, password))
print(response.text)Ответ
json
[
{
"name": "Dictionary",
"content": null,
"id": "5e6a2b573620e824c366266e"
},
...
]