Описание API Планировщика Заданий
Новое Задание
Создает новое задание.
Запрос
Swagger
POST
/createТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Получение атрибутов Задания
Возвращает атрибуты Задания.
Запрос
Swagger
POST
/getТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Получение списка Заданий
Возвращает список Заданий, упорядоченных по имени.
Запрос
Swagger
POST
/listТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | undefined[] |
Удаление Задания
Удаляет Задание с заданным в запросе именем.
Запрос
Swagger
POST
/deleteТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Запуск Задания
Запускает выполнение Задания.
Запрос
Swagger
POST
/runТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Изменение Задания
Изменяет Задание.
Запрос
Swagger
POST
/updateТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Приостановка Задания
Приостанавливает автоматический запуск Задания.
Запрос
Swagger
POST
/pauseТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
result | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Возобновление Задания
Возобновляет автоматический запуск Задания.
Запрос
Swagger
POST
/resumeТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | One of the available methods of the service |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object |
Поиск Задания
Возвращает одно или несколько найденных Заданий.
Запрос
Swagger
POST
/searchТело запроса
| Параметр | Тип | Описание |
|---|---|---|
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
/searchJobInstanceТело запроса
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
method | string | |
params | object | |
id | string |
Ответ
| Параметр | Тип | Описание |
|---|---|---|
jsonrpc | string | |
id | string | |
result | object | |
rowsCount | integer |
Модели
CreateRequestBody
CreateResponseBody
GetRequestBody
GetResponseBody
ListRequestBody
ListResponseBody
DeleteRequestBody
DeleteResponseBody
RunRequestBody
RunResponseBody
UpdateRequestBody
UpdateResponseBody
PauseRequestBody
PauseResponseBody
ResumeRequestBody
ResumeResponseBody
SearchRequestBody
SearchResponseBody
SearchJobInstanceRequestBody
SearchJobInstanceResponseBody
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Планировщик заданий
Создание, редактирование и удаление заданий, управление их запуском. Просмотр, сортировка и фильтрация списка заданий, поиск заданий по названию