Описание API для работы с Задачами
Создание новой Задачи (Task)
Создает Задачу.
Запрос
Swagger
POST
/createTaskТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Получение Задачи по наименованию
Возвращает объект Задачи, найденной по наименованию.
Запрос
Swagger
POST
/getTaskТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Получение списка Задач
Возвращает массив объектов — список Задач, упорядоченный по имени.
Запрос
Swagger
POST
/listTasksТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Поиск Задачи
Возвращает найденную Задачу по фильтрам: название соответствующей Очереди, наименование Задачи, описание, статус.
Запрос
Swagger
POST
/searchTasksТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object | |
rowsCount | integer |
Получение количества Задач в Очереди
Возвращает массив объектов — список Задач в Очереди, разбитых по всем возможным статусам Задачи.
Запрос
Swagger
POST
/getTasksSummaryТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Отмена Задачи
Отменяет Задачу со статусом `READY` или `BLOCKED`.
Запрос
Swagger
POST
/cancelTaskТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Повторный запуск Задачи
Повторно запускает задачу со статусом `FAILED`.
Запрос
Swagger
POST
/restartTaskТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Модели
CreateTaskRequestBody
CreateTaskResponseBody
GetTaskRequestBody
GetTaskResponseBody
ListTasksRequestBody
ListTasksResponseBody
SearchTasksRequestBody
SearchTasksResponseBody
GetTasksSummaryRequestBody
GetTasksSummaryResponseBody
CancelTaskRequestBody
CancelTaskResponseBody
RestartTaskRequestBody
RestartTaskResponseBody
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Пакетная обработка задач
Создание, настройка и удаление очередей, заполнение очередей задачами. Просмотр списков созданных очередей и задач в каждой очереди