Контроллер управления задачами
/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 | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
/api/Task/Delete
Удалить задачу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры удаления задачи
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | нет | ||
| code | string | да | ||
| isError | boolean | да | ||
| stackTrace | string | нет | ||
| innerErrors | IErrorDescription[] | нет | ||
| techMessage | string | нет | ||
| dateTime | string (date-time) | нет | ||
| data | object | нет | ||
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/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) | идентификатор | нет |
/api/Task/List
Получить список задач
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
/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 | нет | ||
| code | string | да | ||
| isError | boolean | да | ||
| stackTrace | string | нет | ||
| innerErrors | IErrorDescription[] | нет | ||
| techMessage | string | нет | ||
| dateTime | string (date-time) | нет | ||
| data | object | нет | ||
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/Task/Start
Запуск задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | нет | ||
| code | string | да | ||
| isError | boolean | да | ||
| stackTrace | string | нет | ||
| innerErrors | IErrorDescription[] | нет | ||
| techMessage | string | нет | ||
| dateTime | string (date-time) | нет | ||
| data | object | нет | ||
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/Task/Stop
Остановка задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string (uuid) | идентификатор | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | нет | ||
| code | string | да | ||
| isError | boolean | да | ||
| stackTrace | string | нет | ||
| innerErrors | IErrorDescription[] | нет | ||
| techMessage | string | нет | ||
| dateTime | string (date-time) | нет | ||
| data | object | нет | ||
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/Task/Upload
Загрузить задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
данные загружаемых задач
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| info | string | данные задач | нет | |
| rewrite | boolean | флаг обновления существующей задачи (true - перезапись, false - игнорирование) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | нет | ||
| code | string | да | ||
| isError | boolean | да | ||
| stackTrace | string | нет | ||
| innerErrors | IErrorDescription[] | нет | ||
| techMessage | string | нет | ||
| dateTime | string (date-time) | нет | ||
| data | object | нет | ||
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
/api/Task/Download
Выгрузить задачи
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| tasks | string[] | Массив имён задач | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | нет | ||
| code | string | да | ||
| isError | boolean | да | ||
| stackTrace | string | нет | ||
| innerErrors | IErrorDescription[] | нет | ||
| techMessage | string | нет | ||
| dateTime | string (date-time) | нет | ||
| data | object | нет | ||
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |