Изменить возможные значения поля задачи

PATCH

https://api.tracker.yandex.net/v3/fields/<id_поля>?version=<текущая_версия_поля>

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

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

PATCH /v3/fields/<id_поля>?version=<текущая_версия_поля>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен> 
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name":
    {
        "en": "Название поля на английском языке",
        "ru": "Название поля на русском языке"
    },
    "category": "0000000000000002********",
    "order": 102,
    "description": "Описание поля",
    "readonly": true,
    "hidden": false,
    "visible": false, 
    "optionsProvider":
      {
       "type": "FixedListOptionsProvider",
       "values": 
          ["значение 1", "значение 2"]
      }
}
Заголовки

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_поля> Идентификатор поля задачи. Строка
<текущая_версия_поля> Текущая версия поля задачи. Строка
Параметры тела запроса

Дополнительные параметры

Параметр Описание Тип данных
name Название локального поля:
  • en — на английском языке;
  • ru — на русском языке.
 Строка
category Объект с информацией о категории поля.
Чтобы получить список всех категорий, используйте HTTP запрос:
GET /v3/fields/categories		 Строка
order Порядковый номер в списке полей организации: https://tracker.yandex.ru/admin/fields. Число
description Описание поля. Строка
readonly Возможность редактировать значение поля:
  • true — значение поля нельзя изменить;
  • false — значение поля можно изменить.
 Логический
hidden Признак видимости поля в интерфейсе:
  • true — скрывать поле даже в том случае, если оно заполнено;
  • false — не скрывать поле.
 Логический
visible Признак отображения поля в интерфейсе:
  • true — всегда отображать поле в интерфейсе;
  • false — не отображать поле в интерфейсе.
 Логический
optionsProvider Объект с информацией о допустимых значениях поля. Объект

Поля объекта optionsProvider

Параметр Описание Тип данных
type Тип значений поля. Строка
values Массив со значениями поля. Массив

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит JSON-объект со всеми параметрами поля задачи.

{
    "self": "https://api.tracker.yandex.net/v3/fields/ruName",
    "id": "ruName",
    "name": "ru_name",
    "description": "текст описания",
    "version": 3,
    "schema": {
        "type": "array",
        "items": "string",
        "required": false
    },
    "readonly": false,
    "options": true,
    "suggest": true,
    "suggestProvider": {
        "type": "UserSuggestProvider"
    },
    "optionsProvider": {
        "type": "FixedListOptionsProvider",
        "values": [
            "value 1",
            "value 2"
        ]
    },
    "queryProvider": {
        "type": "StringOptionalQueryProvider"
    },
    "order": 14,
    "category": {
        "self": "https://api.tracker.yandex.net/v3/fields/categories/58bc3b921d9c********",
        "id": "58bc3b921d9c********",
        "display": "Системные"
    }
}
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о поле задачи. Строка
id Идентификатор поля. Строка
name Название поля. Строка
description Описание поля. Строка
version Версия поля. Каждое изменение поля увеличивает номер версии. Число
schema Объект с информацией о типе данных значения поля. Объект
readonly Возможность редактировать значение поля:
  • true — значение поля нельзя изменить;
  • false — значение поля можно изменить.
 Логический
options Ограничение списка значений:
  • true — список значений не ограничен, можно задать любое значение;
  • false — список значений ограничен настройками организации.
 Логический
suggest Наличие подсказки при вводе значения поля:
  • true — при вводе значения появляется поисковая подсказка;
  • false — функция поисковой подсказки отключена.
 Логический
suggestProvider Объект с информацией о классе поисковой подсказки.
Класс подсказки невозможно изменить с помощью API.		 Объект
optionsProvider Объект с информацией о допустимых значениях поля. Объект
queryProvider Объект с информацией о классе языка запроса.
Класс невозможно изменить с помощью API.		 Объект
order Порядковый номер в списке полей организации: https://tracker.yandex.ru/admin/fields Число
category Объект с информацией о категории поля.
Чтобы получить список всех категорий, используйте HTTP запрос:
GET /v3/fields/categories		 Объект

Поля объекта schema

Параметр Описание Тип данных
type Тип значения поля. Возможные типы данных:
  • string — строка. Присутствует у полей с единственным значением.
  • array — массив. Присутствует у полей с несколькими значениями.
 Строка
items Тип значений. Присутствует у полей с несколькими значениями. Строка
required Обязательность заполнения поля:
  • true — поле обязательно для заполнения;
  • false — поле не обязательно для заполнения.
 Логический

Поля объекта suggestProvider

Параметр Описание Тип данных
type Класс поисковой подсказки. Строка

Поля объекта optionsProvider

Параметр Описание Тип данных
type Тип значений поля. Строка
values Массив со значениями поля. Массив

Поля объекта queryProvider

Параметр Описание Тип данных
type Тип языка запроса. Строка

Поля объекта category

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о категории поля. Строка
id Идентификатор категории поля. Строка
display Отображаемое название категории. Строка

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
412
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
422
Ошибка валидации JSON, запрос отклонен.
428
Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Изменить название поля задачи
Следующая
Создать категорию поля задачи