Редактировать доску

Формат запроса

Чтобы изменить параметры доски, используйте HTTP-запрос с методом PATCH:

PATCH /v2/boards/<board-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
If-Match: "<номер версии>"

{
 "name" : "Тестирование",
 "columns": 
    [
      {
        "id": "1",
        "name": "Открыт",
        "statuses": "open"
       },
        ...
     ],
 "filter": {
      "<ключ параметра 1>": "<значение 1>",
      "<ключ параметра 2>": [
          "<значение 2>", 
                        ...
       ],
        ...
    },
 "orderBy": "updated",
 "orderAsc": false,
 "query": "<Параметр 1>: <Значение 1> AND <Параметр 2>: <Значение 2> OR <Параметр 3>: <Значение 3>...",
 "useRanking": false,
 
 "country": {
     "id": "1"
  }
}

Ресурс

<board-id>

Идентификатор доски.

Заголовки

Host

Адрес узла, предоставляющего API:

https://api.tracker.yandex.net

Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07

X-Org-ID

Идентификатор организации.

If-Match

Номер текущей версии доски. При указании неактуальной версии доски в ответ на HTTP-запрос придет ответ с ошибкой 412 Precondition Failed.

Тело запроса

Тело запроса содержит параметры доски, которые нужно изменить.

Параметр	Описание	Тип данных
name	Название доски.	Строка.
columns	Объект с информацией о новых колонках доски.	Объект.
filter	Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски. Параметры задачи состоят из полей и значений. Группа параметров filter, orderBy и orderAsc несовместима с параметром query, который также описывает условия фильтра.	Объект.
orderBy	Ключ поля. Поле служит параметром для сортировки задач на доске. Полный список полей: https://tracker.yandex.ru/admin/fields	Строка.
orderAsc	Направление сортировки: true — по возрастанию значений поля false — по убыванию значений поля	Логический.
query	Параметры фильтра, с помощью которого отбираются задачи для доски. Параметры задаются на языке запросов. Параметр query несовместим с группой параметров, которые также описывают условия фильтра: filter, orderBy и orderAsc.	Строка.
useRanking	Возможность менять порядок задач на доске: true— разрешено false— запрещено	Логический.
country	Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач. Чтобы получить список стран, используйте HTTP-запрос: GET /v2/countries	Объект.
Поля объекта columns
id	Идентификатор колонки.	Строка.
name	Название колонки.	Строка.
statuses	Ключ статуса задач, которые попадут в колонку. Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses	Строка.
Поля объекта filter
<ключ параметра 1>	Ключ поля, который является параметром отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields	Строка.
<ключ параметра 2>	Массив с ключами полей, которые являются параметрами отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields	Массив.
Поля объекта country
id	Идентификтор страны.	Строка.

Параметр	Описание	Тип данных
name	Название доски.	Строка.
columns	Объект с информацией о новых колонках доски.	Объект.
filter	Объект с информацией об условиях фильтра, с помощью которого отбираются задачи для доски. Параметры задачи состоят из полей и значений. Группа параметров filter, orderBy и orderAsc несовместима с параметром query, который также описывает условия фильтра.	Объект.
orderBy	Ключ поля. Поле служит параметром для сортировки задач на доске. Полный список полей: https://tracker.yandex.ru/admin/fields	Строка.
orderAsc	Направление сортировки: true — по возрастанию значений поля false — по убыванию значений поля	Логический.
query	Параметры фильтра, с помощью которого отбираются задачи для доски. Параметры задаются на языке запросов. Параметр query несовместим с группой параметров, которые также описывают условия фильтра: filter, orderBy и orderAsc.	Строка.
useRanking	Возможность менять порядок задач на доске: true— разрешено false— запрещено	Логический.
country	Объект с информацией о стране. Данные производственного календаря страны используются в Диаграмме сгорания задач. Чтобы получить список стран, используйте HTTP-запрос: GET /v2/countries	Объект.
Поля объекта columns
id	Идентификатор колонки.	Строка.
name	Название колонки.	Строка.
statuses	Ключ статуса задач, которые попадут в колонку. Список всех статусов задачи: https://tracker.yandex.ru/admin/statuses	Строка.
Поля объекта filter
<ключ параметра 1>	Ключ поля, который является параметром отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields	Строка.
<ключ параметра 2>	Массив с ключами полей, которые являются параметрами отбора задач на доску. Полный список полей: https://tracker.yandex.ru/admin/fields	Массив.
Поля объекта country
id	Идентификтор страны.	Строка.

Формат ответа

{
  "self" : "http://api.tracker.yandex.net/v2/boards/1",
  "id" : 1,
  "version" : 1412806202302,
  "name" : "Тестирование", 
  "columns" : 
  [ 
   {
     "self" : "http://api.tracker.yandex.net/v2/boards/1/columns/1387461731452",
     "id" : "1387461731452",
     "display" : "Открыт"
   },
    ...
  ],
  "filter": {
      "<ключ параметра 1>": "<значение 1>",
      "<ключ параметра 2>": [
          "<значение 2>", 
                        ...
       ],
        ...
    },
   "orderBy": "updated",
   "orderAsc": false,
   "query": "<Параметр 1>: <Значение 1> AND <Параметр 2>: <Значение 2> OR <Параметр 3>: <Значение 3>...",
   "useRanking": false,
   
   "country": {
       "self": "https://api.tracker.yandex.net/v2/countries/1",
       "id": "1",
       "display": "Россия"
        }
   }