PUT /cards
Описание
Обновляет данные указанной карточки и возвращает пустой JSON объект.
Этот маршрут обрабатывает HTTP PUT запрос, отправленный на эндпоинт /cards/{id}
.
Параметры пути
В пути запроса присутствует следующий параметр:
Имя | Тип | Описание |
---|---|---|
id | число | Обязательный. ID карточки для обновления. |
Тело запроса
Сервер ожидает JSON объект, содержащий объект карточки со всеми его свойствами, включая как неизменённые, так и обновлённые значения.
Имя | Тип | Описание |
---|---|---|
label | строка | Обязательный. Название карточки для обновления. |
description | строка | Обязательный. Описание карточки. |
column | число | Обязательный. ID колонки, к которой принадлежит карточка. |
row | число | Обязательный. ID строки, к которой принадлежит карточка. |
start_date | строка | Обязательный. Дата начала в формате ISO yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
end_date | строка | Обязательный. Дата окончания в формате ISO yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
progress | число | Обязательный. Значение прогресса от 0 до 100. |
attached | объект | Обязательный. Массив с данными о прикреплённых файлах. Пример объекта доступен здесь cards |
color | строка | Обязательный. Цвет верхней линии карточки в HEX формате. |
priority | число | Обязательный. ID приоритета карточки. |
users | объект | Обязательный. Массив с ID назначенных пользователей. Пример объекта доступен здесь cardShape |
Пример:
{
"card": {
"label": "Drag and drop",
"description": "",
"column": 3,
"row": 1,
"start_date": null,
"end_date": "2018-01-01T00:00:00Z",
"progress": 100,
"attached": [],
"color": "#58C3FE",
"priority": 2,
"users": []
},
}
Другой пример объекта карточки доступен в разделе cards.
Ответ
Если обновление прошло успешно, сервер возвращает пустой JSON объект.
HTTP статус код указывает на результат запроса: успех - статус 200, ошибка - статус 500.
Связанные статьи: Работа с сервером