Параметры задач в запросах к API и ответах
При работе с задачами через API вы можете использовать различные параметры для создания, редактирования и получения информации о задачах.
В этой документации описаны стандартные параметры задачи, которые доступны в Трекере по умолчанию, а также стандартные объекты, которые могут содержаться в задаче:
Помимо стандартных параметров, задачи могут содержать:
- Пользовательские глобальные поля, созданные в организации.
- Локальные поля, специфичные для конкретной очереди.
Глобальные поля
Глобальные поля можно использовать в задачах во всех очередях Трекера. По умолчанию в Трекере доступны самые популярные поля задач.
Дополнительные глобальные поля может создать администратор организации. Как добавить в Трекер глобальное поле.
Список всех глобальных полей можно посмотреть на странице Настройки Трекера.
Локальные поля
Локальное поле можно использовать только в задачах той очереди, к которой оно привязано. Преимущество локальных полей в том, что владелец очереди может управлять такими полями без риска повлиять на процессы работы в других очередях. Пользователи, которые работают в других очередях, не будут видеть это поле в своих задачах.
Как использовать локальные поля, читайте в разделе Локальные поля задач.
Важные моменты при работе с локальными полями через API:
-
Идентификатор локального поля включает шестнадцатеричный префикс и ключ поля:
603fb94c38bbe658********--myfield.Например, чтобы изменить значение локального поля задачи через API, в теле HTTP-запроса на редактирование задачи укажите идентификатор поля:
603fb94c38bbe658********--<ключ_поля>: "<новое_значение_локального_поля>". Как редактировать задачу с помощью API -
Убедитесь, что локальное поле принадлежит указанной очереди.
-
Соблюдайте типы данных согласно схеме поля:
- Для строковых полей используйте строки
- Для числовых полей используйте числа
- Для массивов пользователей используйте объекты с полем
id
-
Чтобы получить список локальных полей очереди, используйте запрос Получить список локальных полей очереди