Перейти к основному содержимому

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.


Связанные статьи: Работа с сервером