Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
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
    • Общий формат запросов
    • Задачи
      • Получить параметры задачи
      • Редактировать задачу
      • Создать задачу
      • Перенести задачу в другую очередь
      • Узнать количество задач
      • Найти задачи
      • Освободить ресурсы просмотра прокрутки
      • Получить приоритеты
      • Получить переходы
      • Выполнить переход в статус
      • Получить историю изменений задачи
      • Связи задачи
        • Связать задачи
        • Получить связи задачи
        • Удалить связь с задачей
    • Чеклисты
      • Создать чеклист или добавить в него пункты
      • Получить параметры чеклиста
      • Редактировать чеклист
      • Удалить чеклист
      • Удалить пункт чеклиста
    • Проекты
      • Создать проект
      • Получить параметры проекта
      • Получить список всех проектов
      • Получить список очередей проекта
      • Изменить проект
      • Удалить проект
    • Комментарии
      • Добавить комментарий
      • Получить комментарии к задаче
      • Редактировать комментарий
      • Удалить комментарий
    • Макросы
      • Получить макросы очереди
      • Получить макрос
      • Создать макрос
      • Редактировать макрос
      • Удалить макрос
    • Внешние связи
      • Получить список внешних приложений
      • Получить список внешних связей задачи
      • Добавить внешнюю связь
      • Удалить внешнюю связь
    • Прикрепленные файлы
      • Получить список прикрепленных файлов
      • Скачать файл
      • Скачать миниатюру
      • Прикрепить файл
      • Загрузить временный файл
      • Удалить файл
    • Очереди
      • Создать очередь
      • Получить параметры очереди
      • Получить список очередей
      • Получить версии очереди
      • Получить обязательные поля очереди
      • Удалить очередь
      • Восстановить очередь
      • Удалить тег из очереди
      • Автоматизация
        • Автодействия
          • Создать автодействие
          • Получить параметры автодействия
        • Триггеры
          • Создать триггер
          • Получить параметры триггера
    • Доски задач
      • Получить параметры всех досок
      • Получить параметры доски
      • Создать доску
      • Редактировать доску
      • Удалить доску
      • Колонки
        • Получить параметры всех колонок
        • Получить параметры колонки
        • Создать колонку
        • Редактировать колонку
        • Удалить колонку
      • Спринты
        • Получить все спринты доски
        • Получить спринт
        • Создать спринт
    • Компоненты
      • Получить список компонентов
    • Импорт
      • Импортировать задачу
      • Импортировать файлы
      • Импортировать комментарии
      • Импортировать связи
    • Пакетные операции
      • Массовый перенос задач в другую очередь
      • Массовое редактирование задач
      • Массовое изменение статуса задач
    • Учет времени
      • Добавить запись о затраченном времени
      • Редактировать запись о затраченном времени
      • Удалить запись о затраченном времени
      • Получить записи о затраченном времени
        • Получить все записи по задаче
        • Отобрать записи по параметрам
    • Поля задачи
      • Получить глобальные поля
      • Создать поле задачи
      • Получить параметры поля задачи
      • Изменить название поля задачи
      • Изменить возможные значения поля задачи
      • Создать категорию поля задачи
      • Локальные поля
        • Создать локальное поле очереди
        • Получить локальные поля очереди
        • Получить информацию о локальном поле очереди
        • Редактировать локальное поле очереди
    • Пользователи
      • Получить информацию о текущем пользователе
      • Получить информацию о пользователях
      • Получить информацию о пользователе
    • Возможные коды ответа
  • Вопросы и ответы
    • Общие вопросы
    • Оплата
  • История изменений
    • Декабрь 2022
    • Ноябрь 2022
    • Октябрь 2022
    • Сентябрь 2022
    • Август 2022
  • Служба поддержки
  1. Справочник API
  2. Очереди
  3. Получить обязательные поля очереди

Получить обязательные поля очереди

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

Запрос позволяет получить информацию об обязательных полях очереди. Очередь выбирается при указании идентификатора или ключа.

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

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

Для получения обязательных полей очереди используйте HTTP-запрос с методом GET.

GET /v2/queues/<queue-id>/fields
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
Заголовки
  • Host

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

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

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

    OAuth 0c4181a7c2cf4521964a72ff57a34a07
    
  • X-Org-ID

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

Ресурс
Параметр Описание Тип данных
<queue-id> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка или число

Пример: Получить обязательные поля очереди TEST.

  • Используется HTTP-метод GET.
GET /v2/queues/TEST/fields HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

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

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v2/fields/stand",
        "id": "stand",
        "name": "Стенд",
        "version": 1361890459119,
        "schema": {
            "type": "string",
            "required": false
        },
        "readonly": false,
        "options": true,
        "suggest": false,
        "optionsProvider": {
            "type": "QueueFixedListOptionsProvider",
            "values": {
                "DIRECT": [
                    "Не указано",
                    "Тестовый",
                    "Разработческий",
                    "Бета",
                    "Production",
                    "Trunk"
                ]
            },
            "defaults": [
                "Не указано",
                "Тестовый",
                "Разработческий",
                "Бета",
                "Production"
            ]
        },
        "queryProvider": {
            "type": "StringOptionalQueryProvider"
        },
        "order": 222
    },
    ....
]
Параметры ответа
Параметр Описание Тип данных
self Ссылка на объект поля. Строка
id Идентификатор поля. Строка
name Название поля. Строка
version Номер версии. Число
schema Объект с информацией о типе содержимого поля. Объект
readonly Признак возможности редактировать поле. Возможные значения:
  • true — редактируемое поле;
  • false — нередактируемое поле.
Логический
options Признак наличия вариантов заполнения поля. Логический
suggest Доступность подсказок при заполнении поля. Логический
optionsProvider Блок с информацией о наборе возможных значений в поле. Объект
queryProvider Информация о типе поля для query-запросов. Объект
order Вес поля при отображении в интерфейсе. Поля с меньшим весом отображаются выше полей с большим весом. Число

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

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

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

Параметр Описание Тип данных
type Информация о типе поля для query-запросов Строка
values Массив с информацией о специальных значениях для очередей Объект
defaults Массив значений поля Массив

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

404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

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

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