Обновить словарь

Обновляет словарь данными, указанными в теле запроса.

Запрос

HTTP Запрос

PATCH /node/api/dictionaries/:id

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

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

id

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

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

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

Тело запроса

{
    "name": "Door state",
    "content": {
        "1": "Closed",
        "2": "Opened"
    }
}

Ответ

Возвращает обновлённый словарь.

Этот запрос добавит все недостающие поля в словарь и заполнит их стандартными значениями.

Пример

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X PATCH $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "name": "Door state",
    "content": {
        "0": "Closed,
        "1": "Opened"
    }
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let dictionaryId = <...>
let path = "/node/api/dictionaries/" + dictionaryId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);

let data = JSON.stringify({
    "name": "Door state",
    "content": {
        "1": "Closed",
        "2": "Opened"
    }
});

let requestOptions = {
    method: "PATCH",
    headers: headers,
    body: data
};

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 dictionaryId = <...>
let path = "/node/api/dictionaries/" + dictionaryId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "PATCH",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "application/json"
    },
    "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);
    });
});

let data = JSON.stringify({
    "name": "Door state",
    "content": {
        "1": "Closed",
        "2": "Opened"
    }
});

req.write(data);
req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
dictionary_id = <...>
url = "https://" + saymon_hostname + "/node/api/dictionaries/" + dictionary_id

body = {
    "name": "Door state",
    "content": {
        "1": "Closed",
        "2": "Opened"
    }
}

response = requests.request("PATCH", url, json=body, auth=(login, password))
print(response.text)

Ответ

{
    "name": "Door state",
    "content": "{\"1\":\"Closed\",\"2\":\"Opened\"}",
    "columns": {},
    "contentType": "object",
    "description": "",
    "group": "67f79f61e2687d00131816a7",
    "id": "5e9eb1bf10b1f754077f3f03"
}

Смотрите также