Создать локальное поле очереди

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

POST

https://api.tracker.yandex.net/v3/queues/<id_очереди>/localFields

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

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

Чтобы создать локальное поле, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON:

POST /v3/queues/<id_очереди>/localFields
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name":
    {
        "en": "Название на английском языке",
        "ru": "Название на русском языке"
    },
    "id": "loc_field_key",
    "category": "0000000000000003********",
    "type": "ru.yandex.startrek.core.fields.StringFieldType"
}

Заголовки
  • 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 — на русском языке.
Строка
id Идентификатор локального поля. Строка
category Объект с информацией о категории поля.
Чтобы получить список всех категорий, используйте HTTP запрос:
GET /v3/fields/categories
Строка
type Тип локального поля:
  • ru.yandex.startrek.core.fields.DateFieldType — Дата;
  • ru.yandex.startrek.core.fields.DateTimeFieldType — Дата/Время;
  • ru.yandex.startrek.core.fields.StringFieldType — Текстовое однострочное поле;
  • ru.yandex.startrek.core.fields.TextFieldType — Текстовое многострочное поле;
  • ru.yandex.startrek.core.fields.FloatFieldType — Дробное число;
  • ru.yandex.startrek.core.fields.IntegerFieldType — Целое число;
  • ru.yandex.startrek.core.fields.UserFieldType — Имя пользователя;
  • ru.yandex.startrek.core.fields.UriFieldType — Ссылка.
Строка

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

Параметр Описание Тип данных
optionsProvider Объект с информацией об элементах списка. Объект
order Порядковый номер в списке полей организации: https://tracker.yandex.ru/admin/fields. Число
description Описание локального поля. Строка
readonly Возможность редактировать значение поля:
  • true — значение поля нельзя изменить;
  • false — значение поля можно изменить.
Логический
visible Признак отображения поля в интерфейсе:
  • true — всегда отображать поле в интерфейсе;
  • false — не отображать поле в интерфейсе.
Логический
hidden Признак видимости поля в интерфейсе:
  • true — скрывать поле даже в том случае, если оно заполнено;
  • false — не скрывать поле.
Логический
container Признак возможности указать в поле одновременно несколько значений (например, как в поле Теги):
  • true — в поле можно указать несколько значений;
  • false — в поле можно указать только одно значение.
Этот параметр допустимо использовать для полей следующих типов:
  • ru.yandex.startrek.core.fields.StringFieldType — Текстовое однострочное поле;
  • ru.yandex.startrek.core.fields.UserFieldType — Имя пользователя;
  • выпадающий список (см. описание объекта optionsProvider).
Логический

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

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

Пример: Создать локальное поле типа «Выпадающий список» с фиксированным набором строковых значений:

  • Используется HTTP-метод POST.
  • Создается локальное поле для очереди DESIGN.
  • Тип поля: FixedListOptionsProvider.
  • Значения в выпадающем списке: «первый элемент списка», «второй элемент списка», «третий элемент списка».
POST /v3/queues/DESIGN/localFields
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
"name":
{
   "en": "Название на английском языке",
   "ru": "Название на русском языке"
},
"id": "loc_field_key",
"category": "0000000000000003********",
"type": "ru.yandex.startrek.core.fields.StringFieldType",
"optionsProvider": {
   "type": "FixedListOptionsProvider",
   "values": [
       "первый элемент списка",
       "второй элемент списка",
       "третий элемент списка"
   ]
}
}

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

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

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

 {
    "type": "local",
    "self": "https://api.tracker.yandex.net/v3/queues/ORG/localFields/loc_field_key",
    "id": "6054ae3a2b6b2c7f********--loc_field_key",
    "name": "Field name",
    "description": "Field description",
    "key": "loc_field_key",
    "version": 1,
    "schema": {
        "type": "string",
        "required": false
    },
    "readonly": true,
    "options": false,
    "suggest": false,
    "queryProvider": {
        "type": "StringOptionalQueryProvider"
    },
    "order": 100, 
    "category": {
        "self": "https://api.tracker.yandex.net/v3/fields/categories/0000000000000003********",
        "id": "0000000000000003********",
        "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 /v3/fields/categories
Объект

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

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

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

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

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

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

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

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

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

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