Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Tracker
  • Начало работы
    • Подключить Tracker
    • Войти в Tracker
    • Добавить пользователей
    • Настроить доступ в Tracker
    • Настроить Tracker
    • Как работать в Tracker
      • Начальная страница
      • Мои задачи
      • Как работать с задачей
      • Избранные задачи, доски, дашборды
      • Персональные настройки
    • Мигрировать в Tracker
    • Отключить платные услуги
  • Мобильное приложение Tracker
  • Практические руководства
    • Настроить Tracker для команды разработки
      • Обзор
      • Создать очередь для команды разработки
      • Структурировать задачи
      • Использовать гибкие методологии (Agile)
      • Настроить шаблоны задач
      • Подключить репозиторий
      • Автоматизировать рутинные действия
      • Интегрировать Tracker с другими системами
    • Настроить Tracker для службы поддержки
      • Обзор
      • Создать очередь для службы поддержки
      • Принимать обращения по почте и через форму
      • Настроить многоуровневую структуру поддержки
      • Отправлять письма со страницы задачи
      • Группировать обращения по темам
      • Отслеживать время обработки обращений
      • Собирать статистику по обращениям
      • Настроить интеграцию со сторонними системами
  • Концепции
    • Обзор сервиса
    • Основные понятия
    • Роли и права доступа
  • Настроить очередь
    • Обзор
    • Создать очередь
    • Шаблоны очередей
    • Просмотреть задачи очереди
    • Изменить основные параметры очереди
    • Настроить типы и статусы задач
      • Обзор
      • Настроить типы задач
      • Создать воркфлоу
      • Настроить статусы
      • Настроить переходы
      • Настроить резолюции
    • Локальные поля задач
    • Добавить команду очереди
    • Настроить доступ к очереди
    • Расширенные возможности очереди
    • Посмотреть историю изменений очереди
    • Удалить очередь
  • Работать с задачами
    • Создать задачу
      • Обзор
      • Создать задачу по почте
      • Создать задачу из формы
      • Клонировать задачу
    • Редактировать задачу
      • Обзор
      • Добавить комментарии к задаче
      • Создать чеклист
      • Изменить связи задачи
      • Прикрепить к задаче изображения и файлы
      • Форматировать текст в задаче
      • Выполнить макрос
      • Проголосовать за задачу
      • Перенести задачу в другую очередь
      • Изменить несколько задач
    • Настроить напоминание о задаче
    • Указать затраченное время
    • Добавить поле задачи
    • Посмотреть историю изменений задачи
    • Получить доступ к задаче
    • Удалить задачу
  • Структурировать задачи
    • Обзор
    • Связи между задачами
    • Проекты
    • Компоненты
    • Версии
  • Проекты (бета)
    • Обзор
    • Создать проект
    • Список задач проекта
    • Диаграмма Ганта
  • Инструменты гибкой разработки
    • Обзор
    • Создать доску
    • Работать с доской
    • Изменить и удалить доску
    • Спринты
    • Эпики
    • Командная оценка задач
    • Диаграмма сгорания задач
  • Доски задач (бета)
    • Обзор
    • Создать доску
    • Работать с доской
    • Настроить доску
  • Найти задачи
    • Найти задачу по ключу или названию
    • Найти мои задачи
    • Найти задачи в очереди
    • Создать фильтр задач
    • Язык запросов
  • Уведомления и подписки
    • Обзор
    • Подписаться на уведомления
    • Получать отчет об изменениях
    • Подписать пользователей на изменения очереди
    • Настройки почтовых уведомлений
      • Обзор
      • Уведомления о ваших задачах
      • Уведомления о ваших подписках
    • Отправлять уведомления на почтовые ящики в вашем домене
  • Статистика и дашборды
    • Дашборды
      • Обзор
      • Как создать дашборд
      • Виджеты
      • Как изменить дашборд
      • Общий доступ к дашбордам
      • Как сделать дашборд начальной страницей
    • Статистика очереди
    • Диаграмма Ганта
  • Автоматизация и шаблоны
    • Обзор
    • Триггеры
      • Обзор
      • Создать триггер
      • Задать условие срабатывания триггера
      • Настроить действие триггера
      • Изменить и удалить триггер
      • Примеры
    • Автодействия
      • Обзор
      • Автоматическое обновление задач
      • Создание задач по расписанию
      • Изменить и удалить автодействие
    • Макросы
    • Шаблоны
      • Обзор
      • Создать шаблон в Yandex Forms (бета)
      • Создать шаблон
      • Изменить шаблон
      • Удалить шаблон
      • Использовать общие шаблоны
    • Переменные
    • Использовать форму как шаблон для создания задач
  • Настроить SLA для задач
    • Обзор
    • Настроить правила
    • Графики работы
  • Интеграция с другими сервисами
    • Почта
    • Yandex Forms
    • Yandex Wiki
    • Мессенджеры
      • Обзор
      • Slack
      • Telegram
    • Настроить связи с внешним приложением
      • Обзор
      • Подготовить внешнее приложение
      • Передать данные приложения команде Tracker
  • Инструменты разработчика
    • API
    • Python клиент
    • Подключить репозиторий
  • Правила тарификации
    • Тарифы
    • Настроить платежный аккаунт
    • Оплатить услуги
    • Посмотреть детализацию услуг
  • Справочник API
    • Обзор
    • Доступ к API
    • Общий формат запросов
    • Задачи
      • Получить параметры задачи
      • Редактировать задачу
      • Создать задачу
      • Перенести задачу в другую очередь
      • Узнать количество задач
      • Найти задачи
      • Освободить ресурсы просмотра прокрутки
      • Получить приоритеты
      • Получить переходы
      • Выполнить переход в статус
      • Получить историю изменений задачи
      • Связи задачи
        • Связать задачи
        • Получить связи задачи
        • Удалить связь с задачей
    • Чеклисты
      • Создать чеклист или добавить в него пункты
      • Получить параметры чеклиста
      • Редактировать чеклист
      • Удалить чеклист
    • Проекты
      • Создать проект
      • Получить параметры проекта
      • Получить список всех проектов
      • Получить список очередей проекта
      • Изменить проект
      • Удалить проект
    • Комментарии
      • Добавить комментарий
      • Получить комментарии к задаче
      • Редактировать комментарий
      • Удалить комментарий
    • Макросы
      • Получить макросы очереди
      • Получить макрос
      • Создать макрос
      • Редактировать макрос
      • Удалить макрос
    • Внешние связи
      • Получить список внешних приложений
      • Получить список внешних связей задачи
      • Добавить внешнюю связь
      • Удалить внешнюю связь
    • Прикрепленные файлы
      • Получить список прикрепленных файлов
      • Скачать файл
      • Скачать миниатюру
      • Прикрепить файл
      • Загрузить временный файл
      • Удалить файл
    • Очереди
      • Создать очередь
      • Получить параметры очереди
      • Получить список очередей
      • Получить версии очереди
      • Получить обязательные поля очереди
      • Удалить очередь
      • Восстановить очередь
      • Удалить тег из очереди
      • Автоматизация
        • Автодействия
          • Создать автодействие
          • Получить параметры автодействия
        • Тригеры
          • Создать триггер
          • Получить параметры триггера
    • Доски задач
      • Получить параметры всех досок
      • Получить параметры доски
      • Создать доску
      • Редактировать доску
      • Удалить доску
      • Колонки
        • Получить параметры всех колонок
        • Получить параметры колонки
        • Создать колонку
        • Редактировать колонку
        • Удалить колонку
      • Спринты
        • Получить все спринты доски
        • Получить спринт
        • Создать спринт
    • Компоненты
      • Получить список компонентов
    • Импорт
      • Импортировать задачу
      • Импортировать файлы
      • Импортировать комментарии
      • Импортировать связи
    • Пакетные операции
      • Массовый перенос задач в другую очередь
      • Массовое редактирование задач
      • Массовое изменение статуса задач
    • Учет времени
      • Добавить запись о затраченном времени
      • Редактировать запись о затраченном времени
      • Удалить запись о затраченном времени
      • Получить записи о затраченном времени
        • Получить все записи по задаче
        • Отобрать записи по параметрам
    • Поля задачи
      • Получить глобальные поля
      • Создать поле задачи
      • Получить параметры поля задачи
      • Изменить название поля задачи
      • Изменить возможные значения поля задачи
      • Создать категорию поля задачи
      • Локальные поля
        • Создать локальное поле очереди
        • Получить локальные поля очереди
        • Получить информацию о локальном поле очереди
        • Редактировать локальное поле очереди
    • Пользователи
      • Получить информацию о текущем пользователе
      • Получить информацию о пользователях
      • Получить информацию о пользователе
    • Возможные коды ответа
  • Вопросы и ответы
    • Общие вопросы
    • Оплата
  • Служба поддержки
  1. Справочник API
  2. Поля задачи
  3. Локальные поля
  4. Редактировать локальное поле очереди

Редактировать локальное поле очереди

Статья создана
Yandex Cloud
  • Формат запроса
  • Формат ответа

Запрос позволяет редактировать локальное поле задачи, привязанное к заданной очереди.

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

Перед выполнением запроса получите доступ к API.

Чтобы изменить локальное поле, используйте HTTP-запрос с методом PATCH. Параметры запроса передаются в его теле в формате JSON:

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

{
    "name":
    {
        "en": "Название поля на английском языке",
        "ru": "Название поля на русском языке"
    },
    "category": "000000000000000000000002",
    "order": 102,
    "description": "Описание поля",
    "readonly": true,
    "visible": false, 
    "hidden": false
}
Заголовки
  • Host

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

    https://api.tracker.yandex.net
    
  • Authorization

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

    OAuth 0c4181a7c2cf4521964a72ff57a34a07
    
  • X-Org-ID

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

Ресурс
Параметр Описание Тип данных
<queue-id> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка
<field-key> Ключ локального поля.
Чтобы получить ключ, используйте HTTP запрос:
GET /v2/queues/<queue-id>/localFields
Строка
Параметры тела запроса

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

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

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

Параметр Описание Тип данных
type Тип выпадающего списка:
  • FixedListOptionsProvider — список строковых или числовых значений (для полей с типом ru.yandex.startrek.core.fields.StringFieldType или ru.yandex.startrek.core.fields.IntegerFieldType);
  • FixedUserListOptionsProvider — список пользователей (для полей с типом ru.yandex.startrek.core.fields.UserFieldType).
Строка
values Значения для выпадающего списка. Массив строк

Пример: Отредактировать фиксированный набор строковых значений локального поля типа Выпадающий список.

  • Используется HTTP-метод PATCH.
  • Тип поля: FixedListOptionsProvider.
  • Значения в выпадающем списке: Первый элемент списка, Второй элемент списка, Третий элемент списка.
PATCH /v2/queues/<queue-id>/localFields/<field-key>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

{
    "optionsProvider": {
    "type": "FixedListOptionsProvider",
    "values": [
         "Первый элемент списка",
         "Второй элемент списка",
         "Третий элемент списка"
       ]
   }
}

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

Запрос выполнен успешно
Запрос выполнен с ошибкой

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

Тело ответа содержит информацию о локальном поле очереди в формате JSON.

 {
    "type": "local",
    "self": "https://api.tracker.yandex.net/v2/queues/ORG/localFields/loc_field_key",
    "id": "6054ae3a2b6b2c7f80bb9a93--loc_field_key",
    "name": "Название поля на русском языке",
    "description": "Описание поля",
    "key": "loc_field_key",
    "version": 2,
    "schema": {
        "type": "string",
        "required": false
    },
    "readonly": true,
    "options": true,
    "suggest": false,
    "optionsProvider": {
       "type": "FixedListOptionsProvider",
       "needValidation": true,
       "values": [
          "Первый элемент списка",
          "Второй элемент списка",
          "Третий элемент списка"
         ]
      },
    "queryProvider": {
         "type": "StringOptionalQueryProvider"
    },
    "order": 102, 
    "category": {
        "self": "https://api.tracker.yandex.net/v2/fields/categories/000000000000000000000002",
        "id": "000000000000000000000002",
        "display": "category_name"
    },    
    "queue": {
        "self": "https://api.tracker.yandex.net/v2/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Организация"
    }
 }
Параметры ответа
Параметр Описание Тип данных
type Тип поля. Строка
self Адрес ресурса API, который содержит информацию о поле. Строка
id Уникальный идентификатор поля. Строка
name Название поля. Строка
description Описание поля. Строка
key Ключ поля. Строка
version Версия поля. Каждое изменение поля увеличивает номер версии. Число
schema Объект с информацией о типе данных значения поля. Объект
readonly Возможность редактировать значение поля:
  • true — значение поля нельзя изменить;
  • false — значение поля можно изменить.
Логический
options Ограничение списка значений:
  • true — список значений не ограничен, можно задать любое значение;
  • false — список значений ограничен настройками организации.
Логический
suggest Наличие подсказки при вводе значения поля:
  • true — при вводе значения появляется поисковая подсказка;
  • false — функция поисковой подсказки отключена.
Логический
optionsProvider Объект с информацией о допустимых значениях поля. Объект
queryProvider Объект с информацией о классе языка запроса.
Класс невозможно изменить с помощью API.
Объект
order Порядковый номер в списке полей организации: https://tracker.yandex.ru/admin/fields Число
category Объект с информацией о категории поля.
Чтобы получить список всех категорий, используйте HTTP запрос:
GET /v2/fields/categories
Объект
queue Объект с информацией об очереди задачи. Объект

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

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

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

Параметр Описание Тип данных
type Тип выпадающего списка. Строка
needValidation Проверка значения на валидность:
  • true — проверять значение списка на валидность;
  • false — не проверять значение списка на валидность.
Логический
values Значения для выпадающего списка. Массив строк

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

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

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

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

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

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

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

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

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Формат запроса
  • Формат ответа