Связаться с намиПодключиться

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

Статья создана
Обновлена 26 августа 2024 г.

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

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

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

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

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

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

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка
<ключ_поля> Ключ локального поля.
Чтобы получить ключ, используйте HTTP запрос:
GET /v2/queues/<ключ_или_идентификатор_очереди>/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/<ключ_или_идентификатор_очереди>/localFields/<ключ_поля>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-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": "6054ae3a2b6b2c7f********--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/0000000000000002********",
        "id": "0000000000000002********",
        "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 временно недоступен.
Предыдущая
Получить информацию о локальном поле очереди
Следующая
Получить информацию о текущем пользователе