Подключиться
Yandex Tracker

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

Статья создана

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

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

PATCH /v2/fields/<field-id>?version=<field-version>
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>

{
  "name":
      {"en":"en_name",
       "ru":"ru_name"
      }
}

Заголовки

  • Host

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

    https://api.tracker.yandex.net

  • Authorization

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

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

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

Ресурс

  • <field-id>

    Идентификатор поля задачи.

  • <field-version>

    Версия поля задачи.

Тело запроса

Тело запроса содержит параметры нового имени поля.

Параметр Описание Тип данных
name Объект с информацией об имени поля задачи. Объект

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

Параметр Описание Тип данных
en Название поля на английском языке. Строка
ru Название поля на русском языке. Строка

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит 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/58bc3b921d9c7d68164e",
        "id": "58bc3b921d9c7d68164e",
        "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 /v2/fields/categories		 Объект

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

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

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

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

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

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

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

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

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

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

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

HTTP-код ошибки Описание ошибки
400 Bad Request Один из параметров запроса имеет недопустимое значение или формат данных.
403 Forbidden У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
404 Not Found Запрашиваемый ресурс не найден.
412 Precondition Failed Некорректное значение заголовка.
422 Unprocessable Entity Ошибка валидации JSON, запрос отклонен.
428 Precondition Required Требуется заголовок.
500 Internal Server Error Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503 Service Unavailable Сервис API временно недоступен.
В этой статье: