Изменить название поля задачи
Статья создана
Обновлена 26 августа 2024 г.
Формат запроса
Чтобы изменить название поля задачи, используйте HTTP-запрос с методом PATCH
:
PATCH /v2/fields/<идентификатор_поля>?version=<версия_поля>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name":
{
"en":"en_name",
"ru":"ru_name"
}
}
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>
, например:OAuth 0c4181a7c2cf4521964a72ff********
-
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker
.- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID
. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID
. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-ID
и идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<идентификатор_поля> | Идентификатор поля задачи. | Строка |
<версия_поля> | Версия поля задачи. | Строка |
Параметры тела запроса
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
name | Объект с информацией об имени поля задачи. | Объект |
Поля объекта name
Параметр | Описание | Тип данных |
---|---|---|
en | Название поля на английском языке. | Строка |
ru | Название поля на русском языке. | Строка |
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект со всеми параметрами поля задачи.
{
"self": "https://api.tracker.yandex.net/v2/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": [
"значение 1",
"значение 2"
]
},
"queryProvider": {
"type": "StringOptionalQueryProvider"
},
"order": 14,
"category": {
"self": "https://api.tracker.yandex.net/v2/fields/categories/58bc3b921d9c********",
"id": "58bc3b921d9c********",
"display": "Системные"
}
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о поле задачи. | Строка |
id | Идентификатор поля. | Строка |
name | Название поля. | Строка |
description | Описание поля. | Строка |
version | Версия поля. Каждое изменение поля увеличивает номер версии. | Число |
schema | Объект с информацией о типе данных значения поля. | Объект |
readonly | Возможность редактировать значение поля:
|
Логический |
options | Ограничение списка значений:
|
Логический |
suggest | Наличие подсказки при вводе значения поля:
|
Логический |
suggestProvider | Объект с информацией о классе поисковой подсказки. Класс подсказки невозможно изменить с помощью API. |
Объект |
optionsProvider | Объект с информацией о допустимых значениях поля. | Объект |
queryProvider | Объект с информацией о классе языка запроса. Класс невозможно изменить с помощью API. |
Объект |
order | Порядковый номер в списке полей организации: https://tracker.yandex.ru/admin/fields |
Число |
category | Объект с информацией о категории поля. Чтобы получить список всех категорий, используйте HTTP запрос: GET /v2/fields/categories |
Объект |
Поля объекта schema
Параметр | Описание | Тип данных |
---|---|---|
type | Тип значения поля. Возможные типы данных:
|
Строка |
items | Тип значений. Присутствует у полей с несколькими значениями. | Строка |
required | Обязательность заполнения поля:
|
Логический |
Поля объекта suggestProvider
Параметр | Описание | Тип данных |
---|---|---|
type | Класс поисковой подсказки. | Строка |
Поля объекта optionsProvider
Параметр | Описание | Тип данных |
---|---|---|
type | Тип значений поля. | Строка |
values | Массив со значениями поля. | Массив |
Поля объекта queryProvider
Параметр | Описание | Тип данных |
---|---|---|
type | Тип языка запроса. | Строка |
Поля объекта category
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о категории поля. | Строка |
id | Идентификатор категории поля. | Строка |
display | Отображаемое название категории. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 412
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 428
- Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.