Планировщик

Сервис планировщик. Предназначение сервиса - планировать выполнение задач. Задачи выставляются по расписанию. Расписание может быть одноразовым или повторяющимся.

Взаимодействие с планировщиком осуществляется по протоколу HTTP методом POST. Данные передаются в теле запроса в формате JSON.

Headers (Заголовки)

Обязательные заголовки всх методов POST

где token - Bearer токен авторизации.

Входные параметры

У каждого метода планировщика разные входные параметры в теле запроса. Тело запроса может быть JSON объектом, массивом или параметром.

Пример запроса (Объект)

{
    "id": 1,
    "field": "example",
}

Пример запроса (Массив)

[
    {
        "id": 1,
        "name": "example",
    }
]

Пример запроса (Параметр)

"id": 1

Выходные параметры

Успешное выполнение

Модель тела ответа, в случае успешного выполнения метода:

Пример ответа (Объект)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": {
        "id": 1,
        "name": "example"
    }
}

Пример ответа (Массив)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "example",
        }
    ]
}

Пример ответа (Переменная)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": "example"
}

Пример ответа (Null)

Пример тела ответа, в случае успешного выполнения метода:

{
    "ok": true,
    "result": null
}

Ошибка при выполнении

Модель тела ответа, в случае логической ошибки при выполнении метода:

Error

Модель, описывающая логическую ошибку при выполнении метода:

Пример ответа

Пример тела ответа, в случае логической ошибки при выполнении метода:

{
    "ok": true,
    "result": {
        "error": 1234,
        "description": "Something went wrong!",
    }
}