changeTaskStatus — Смена статуса задания
Используется для изменения статуса задания и передачи результатов выполнения.
Запрос
POST /api/changeTaskStatus
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
SecretKey |
string | Да | Секретный ключ из настроек Цифры |
Id |
integer | Да | ID задания, полученный в методе check |
Status |
string | Да | Новый статус: work, done, failed |
Data |
object | Нет | Информация о выполненном задании (зависит от типа задания) |
Возможные статусы
work— задание взято в работуdone— задание успешно выполненоfailed— задание завершилось с ошибкой
Примеры запросов
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 |
Успешно. Статус задания обновлен |
400 |
Неверный тип данных. Data должен быть массивом |
403 |
Секретный ключ не найден |
Успешный ответ (200)
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Message |
string | Да | Сообщение о результате операции |
Пример ответа
{
"Message": "Статус обновлен"
}
Примечания
- Всегда меняйте статус на
workперед началом выполнения задания - Это предотвращает дублирование заданий и блокирует зависимые задания
- Для заданий создания сущностей обязательно возвращайте Guid в поле
Data.Guid - Для заданий выгрузки данных поле
Dataне требуется
Порядок работы с заданием
- Получить задание через метод check
- Изменить статус на
work - Выполнить необходимые действия в 1С
- Установить статус
doneи отправить результат вData
См. также
- check — проверка наличия заданий
- Двусторонний обмен данных — подробное описание работы системы заданий
- Инструкции по выполнению заданий