Docs HCAPP

Русский

English

Русский

English

Appearance

Log in

Возврат таска на этап ​

Endpoint ​

POST /bot/tasks/{task_id}/step-return

Возвращает таск на предыдущий этап маршрута, используя существующий assignment этого этапа.

Auth ​

http
Authorization: Bearer <bot_token>
Content-Type: application/json

Path params ​

  • task_id - ID таска

Request body ​

json
{
  "assignment_id": 123
}

assignment_id должен принадлежать этому таску и этапу, который находится раньше текущего этапа таска.

Как получить assignment_id ​

Вызовите GET /bot/tasks/{task_id} и проверьте data.step_assignments. Ответ содержит назначения текущего и предыдущих этапов. Выберите assignment_id более раннего этапа; assignment текущего или следующего этапа будет отклонен.

Полная схема назначения описана на странице Чтение таска.

Пример ​

bash
curl -X POST \
  -H "Authorization: Bearer <bot_token>" \
  -H "Content-Type: application/json" \
  -d '{"assignment_id": 123}' \
  https://public-api.hcapp.ee/bot/tasks/5001/step-return

Response body ​

json
{
  "success": true,
  "error_message": null,
  "data": {
    "task_id": 5001,
    "previous_step_id": 8,
    "step_id": 5,
    "assignment_id": 123,
    "responsible_id": 45
  }
}

Для группового assignment поле responsible_id равно null.

Поведение ​

  • Меняет текущий этап таска на этап указанного assignment.
  • Сбрасывает подтверждение выбранного assignment.
  • Назначает пользователя из assignment ответственным. Для группового assignment у таска нет одного responsible_id.
  • Обновляет время активности таска и создает системный комментарий STEP_CHANGED.
  • Создает внутреннюю нотификацию ответственному пользователю или участникам группы.
  • Ставит в очередь внешнюю доставку по включенным каналам нотификаций каждого получателя.

Ошибки ​

  • 422 assignment_id должен быть больше 0.
  • 400 Task is not in a workflow step.
  • 400 Target assignment must belong to an earlier step.
  • 403 Form access not found.
  • 404 Task not found.
  • 404 Assignment with id {id} not found for this task.

Для endpoint действует стандартный bot update rate limit.