Добавить комментарий к аварии

Добавить комментарий в список комментариев аварии.

Последний комментарий хранится и в списке комментариев и в поле аварии comment.

Все комментарии можно получить запросом Получить историю комментариев аварии.

NOTE

Этот запрос не работает с историческими авариями.

Запрос

HTTP Запрос

POST /node/api/incidents/:id/comment

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

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

обязательный | ID аварии, к которой добавляется комментарий. |

Параметры тела запроса

Тело запроса содержит строку с комментарием. Эта строка поддерживает Markdown. Описание используемой версии Markdown можно найти в документации Showdown.

NOTE

Заголовок Content-Type должен быть выставлен в text/plain . При других значениях заголовка, комментарий не добавится и в поле comment запишется значение null .

Тело запроса

Тело запроса содержит текст комментария.

Ответ

Тело ответа пустое.

При отправке этого запроса, комментарий добавляется к спику комментариев аварии. Последний комментарий также хранится в поле аварии comment.

Список всех комментариев можно получить запросом Получить историю комментариев аварии.

Этот запрос не работает с историческими авариями. При попытке добавить комментарий к исторической аварии, этот запрос вернёт ошибку с кодом 500 и следующим телом ответа:

{
    "message": "Cannot read properties of null (reading 'commentsCount')"
}

Пример

Запрос

• Bash
• JavaScript
• NodeJS
• Python

login=<...>
password=<...>
saymon_hostname=<...>
incident_id=<...>
url=https://$saymon_hostname/node/api/incidents/$incident_id/comment

curl -X POST $url -u $login:$password \
    -H "Content-Type: text/plain" \
    --data 'Hello from REST API!'

let login = <...>
let password = <...>
let saymonHostname = <...>
let incidentId = <...>
let path = "/node/api/incidents/" + incidentId + "/comment";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = "Hello from REST API!";

let requestOptions = {
    method: "POST",
    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 incidentId = <...>
let path = "/node/api/incidents/" + incidentId + "/comment";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "text/plain"
    },
    "path": path
};

let req = https.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 = "Hello from REST API!";

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

import requests

login = <...>
password = <...>
saymon_hostname = <...>
incident_id = <...>
url = "https://" + saymon_hostname + "/node/api/incidents/" + \
    incident_id + "/comment"

headers = {
    "Content-Type": "text/plain"
}

comment = "Hello from REST API!"

response = requests.request("POST", url, data=comment,
    headers=headers, auth=(login, password))

print(response.text)

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

• Авария
• Получить историю комментариев аварии