Цифра ↔ 1С

changeTaskStatus — Смена статуса задания

Используется для изменения статуса задания и передачи результатов выполнения.

Запрос

POST /api/changeTaskStatus

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

Параметр Тип Обязательный Описание
SecretKey string Да Секретный ключ из настроек Цифры
Id integer Да ID задания, полученный в методе check
Status string Да Новый статус: work, done, failed
Data object Нет Информация о выполненном задании (зависит от типа задания)

Возможные статусы

Примеры запросов

1. Взять задание в работу

{
  "SecretKey": "2akgzOCYsAxLwpNl",
  "Id": 15,
  "Status": "work"
}

2. Завершить задание с результатом

Для заданий создания сущности (createCar, createCompany и т.д.) нужно вернуть Guid созданной записи:

{
  "SecretKey": "2akgzOCYsAxLwpNl",
  "Id": 15,
  "Status": "done",
  "Data": {
    "Guid": "22db4291-154f-11ec-973e-244bfecb4e0a"
  }
}

3. Завершить задание без результата

Для заданий выгрузки данных (getCompanies, getCars и т.д.) Data не требуется:

{
  "SecretKey": "2akgzOCYsAxLwpNl",
  "Id": 16,
  "Status": "done"
}

Пример curl:

curl -X POST https://1c.cifra.ai/api/changeTaskStatus \
  -H "Content-Type: application/json" \
  -d '{
    "SecretKey": "2akgzOCYsAxLwpNl",
    "Id": 15,
    "Status": "done",
    "Data": {"Guid": "22db4291-154f-11ec-973e-244bfecb4e0a"}
  }'

Ответ

Коды ответов

Код Описание
200 Успешно. Статус задания обновлен
401 Ошибка ключа. Секретный ключ не найден
422 Ошибка валидации. Data должен быть массивом
500 Ошибка сервера. Внутренняя ошибка обработки

Успешный ответ (200)

Поле Тип Обязательное Описание
Message string Да Сообщение о результате операции

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

{
  "Message": "Статус обновлен"
}

Примечания

Порядок работы с заданием

  1. Получить задание через метод check
  2. Изменить статус на work
  3. Выполнить необходимые действия в 1С
  4. Установить статус done и отправить результат в Data

См. также