Создать рабочий процесс

Запрос позволяет создать новый рабочий процесс.

POST

https://api.tracker.yandex.net/v3/workflows

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

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

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

POST /v3/workflows
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name": "Design",
    "queue": "DESIGN",
    "type": "VISUAL",
    "initialAction": {
        "id": "open",
        "name": { "ru": "Открыть", "en": "Open" },
        "target": "open"
    },
    "steps": [
        {
            "status": "open",
            "description": { "ru": "Задача открыта", "en": "Issue is open" },
            "actions": [
                {
                    "id": "inProgress",
                    "name": { "ru": "Взять в работу", "en": "Start progress" },
                    "description": { "ru": "Перевести задачу в работу", "en": "Move issue to in progress" },
                    "target": "inProgress"
                }
            ]
        },
        {
            "status": "inProgress",
            "description": { "ru": "Задача в работе", "en": "Issue is in progress" },
            "actions": [
                {
                    "id": "close",
                    "name": { "ru": "Закрыть", "en": "Close" },
                    "description": { "ru": "Закрыть задачу", "en": "Close the issue" },
                    "target": "closed"
                }
            ]
        },
        {
            "status": "closed",
            "description": { "ru": "Задача закрыта", "en": "Issue is closed" },
            "actions": []
        }
    ],
    "issueTypeResolutions": [
        {
            "issueType": "task",
            "resolutions": ["wontFix", "fixed"]
        }
    ]
}

Заголовки

Host: адрес узла, предоставляющего API.
Authorization: токен для авторизации в одном из форматов:
- OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. Читать подробнее
Content-Type: формат тела запроса. Должен иметь значение application/json.
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,
- если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Параметры тела запроса

Обязательные параметры

Параметр	Описание	Тип данных
name	Название рабочего процесса.	Строка
initialAction	Начальное действие — задает статус, в который попадает задача при создании.	Объект
steps	Массив шагов рабочего процесса. Каждый шаг соответствует статусу и содержит доступные из него переходы.	Массив объектов

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

Параметр	Описание	Тип данных
id	Идентификатор рабочего процесса. Если параметр не указан, API сгенерирует идентификатор вида `W...`.	Строка
queue	Очередь, к которой привязывается рабочий процесс. Можно указать ключ очереди (строка), идентификатор (число) либо объект `{"key": "..."}` / `{"id": ...}` / `{"name": "..."}`. Если параметр не указан, создается общий рабочий процесс. Его можно назначить типам задач в настройках очереди. Создать общий процесс могут пользователи с соответствующими правами.	Строка, число или объект
type	Тип рабочего процесса. Сейчас доступен тип `visual`. В запросе используйте значение `VISUAL`. В ответе API возвращает `visual`. У созданных ранее рабочих процессов поле может отсутствовать.	Строка
issueTypeResolutions	Массив с настройками резолюций для типов задач.	Массив объектов

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

Параметр	Описание	Тип данных	Обязательный
status	Статус шага. Можно указать ключ статуса (строка), идентификатор (число) либо объект `{"key": "..."}` / `{"id": ...}` / `{"name": "..."}`.	Строка, число или объект	Да
description	Описание шага в виде объекта с локализациями, например `{"ru": "...", "en": "..."}`.	Объект	Нет
actions	Массив действий (переходов), доступных из этого статуса.	Массив объектов	Нет
metaAction	Метадействие шага (выполняется автоматически).	Объект	Нет
statusType	Тип статуса. Допустимые значения: `NEW`, `IN_PROGRESS`, `PAUSED`, `DONE`, `CANCELLED`.	Строка	Нет

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

Параметр	Описание	Тип данных	Обязательный
id	Идентификатор действия.	Строка	Нет
name	Название действия в виде объекта с локализациями, например `{"ru": "...", "en": "..."}`.	Объект	Да
description	Описание действия в виде объекта с локализациями.	Объект	Нет
target	Целевой статус, в который переводит действие. Можно указать ключ статуса (строка), идентификатор (число) либо объект `{"key": "..."}` / `{"id": ...}` / `{"name": "..."}`.	Строка, число или объект	Да
screen	Экран перехода с полями, которые можно заполнить при выполнении действия.	Объект	Нет
conditions	Массив условий выполнения действия.	Массив объектов	Нет
functions	Массив функций, выполняемых при переходе.	Массив объектов	Нет

Поля объектов массива issueTypeResolutions

Параметр	Описание	Тип данных	Обязательный
issueType	Ключ или идентификатор типа задачи, для которого настраиваются резолюции. Список доступных типов задач можно получить с помощью запроса.	Строка или число	Да
resolutions	Массив ключей или идентификаторов доступных резолюций для задач данного типа. Список доступных резолюций можно получить с помощью запроса.	Массив строк или чисел	Да

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

Запрос выполнен успешно

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

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

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

Незаполненные необязательные поля API не возвращает в ответе. Например, queue, type, createdBy и updatedBy.

{
    "self": "https://api.tracker.yandex.net/v3/workflows/W21",
    "id": "W21",
    "name": "Design",
    "version": 1,
    "steps": [
        {
            "status": {
                "self": "https://api.tracker.yandex.net/v3/statuses/1",
                "id": "1",
                "key": "open",
                "display": "Открыт"
            },
            "actions": [
                {
                    "id": "inProgress",
                    "name": "Взять в работу",
                    "target": {
                        "self": "https://api.tracker.yandex.net/v3/statuses/3",
                        "id": "3",
                        "key": "inProgress",
                        "display": "В работе"
                    }
                }
            ]
        }
    ],
    "initialAction": {
        "id": "open",
        "name": "Открыть",
        "target": {
            "self": "https://api.tracker.yandex.net/v3/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Открыт"
        }
    },
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
        "id": "4",
        "key": "DESIGN",
        "display": "DESIGN"
    },
    "created": "2026-08-11T14:37:06.356+0000",
    "updated": "2026-08-11T14:37:06.356+0000",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 1100000000
    },
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 1100000000
    },
    "deleted": false,
    "type": "visual"
}

Параметры ответа

Параметр	Описание	Тип данных
self	Ссылка на рабочий процесс.	Строка
id	Идентификатор рабочего процесса.	Строка
name	Название рабочего процесса.	Строка
version	Версия рабочего процесса. Каждое изменение увеличивает номер версии.	Число
steps	Массив шагов рабочего процесса.	Массив объектов
initialAction	Начальное действие.	Объект
queue	Очередь, к которой привязан рабочий процесс.	Объект
created	Дата и время создания.	Строка
updated	Дата и время последнего изменения.	Строка
createdBy	Автор рабочего процесса.	Объект
updatedBy	Пользователь, последним изменивший рабочий процесс.	Объект
deleted	Признак удаленного рабочего процесса.	Логический
type	Тип рабочего процесса. Сейчас единственное значение — `visual`. У созданных ранее рабочих процессов поле может отсутствовать.	Строка

Поля объектов массива steps

Параметр	Описание	Тип данных
status	Статус шага.	Объект
actions	Массив действий (переходов), доступных из этого статуса.	Массив объектов

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

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

Поля объектов action и initialAction

Параметр	Описание	Тип данных
id	Идентификатор действия.	Строка
name	Название действия.	Строка
target	Целевой статус, в который переводит действие.	Объект

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

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

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

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

Поля объекта пользователя (createdBy, updatedBy)

Параметр	Описание	Тип данных
self	Ссылка на пользователя.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка
cloudUid	Уникальный идентификатор пользователя в Яндекс Облаке.	Строка
passportUid	Уникальный идентификатор аккаунта пользователя в Яндекс Паспорте.	Число

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400: Один или несколько параметров запроса имеют недопустимое значение.

401: Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

422: Ошибка валидации JSON, запрос отклонен.

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

Получить права доступа группы в очереди

Получить список рабочих процессов