Task
/services/taskschedulerservice/api/Task/Create
Создать задачу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры новой задачи
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | нет | ||
| description | string | нет | ||
| enabled | boolean | нет | ||
| isSystem | boolean | нет | ||
| attemptsNumber | integer (int32) | нет | ||
| attemptsInterval | integer (int32) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Identifier | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/taskschedulerservice/api/Task/Delete
Удалить задачу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры удаления задачи
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/taskschedulerservice/api/Task/Get
Получить информацию о задаче
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры получения задачи
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | нет | ||
| description | string | нет | ||
| enabled | boolean | нет | ||
| isSystem | boolean | нет | ||
| status | string | нет | ||
| lastRun | string (date-time) | нет | ||
| succesfullLastRun | string (date-time) | нет | ||
| attemptsNumber | integer (int32) | нет | ||
| attemptsInterval | integer (int32) | нет | ||
| owner | string | нет | ||
| actionIds | string(uuid)[] | нет | ||
| triggerIds | string(uuid)[] | нет | ||
| id | string (uuid) | нет |
/services/taskschedulerservice/api/Task/List
Получить список задач
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/services/taskschedulerservice/api/Task/Update
Обновить данные задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описа ние | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | нет | ||
| name | string | нет | ||
| description | string | нет | ||
| enabled | boolean | нет | ||
| isSystem | boolean | нет | ||
| attemptsNumber | integer (int32) | нет | ||
| attemptsInterval | integer (int32) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/taskschedulerservice/api/Task/Start
Запуск задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные знач ения |
|---|---|---|---|---|
| id | string (uuid) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/taskschedulerservice/api/Task/Stop
Остановка задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/taskschedulerservice/api/Task/Upload
Загрузить задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
данные загружаемых задач
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| info | string | нет | ||
| rewrite | boolean | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/taskschedulerservice/api/Task/Download
Выгрузить задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| tasks | string[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |