Описание шаблонов заданий

Этот API позволяет получить список шаблонов заданий с их параметрами и дополнительной информацией.

Как получить данные

Метод

GET

Адрес запроса

Для получения данных используйте адрес: https://tasks.<server_address>/backend/public/dictionary/initiators
Параметры запроса
  • page  —  страница для выборки (служебное поле для визуализации таблиц). По умолчанию — 1
  • start — смещение для SQL-запроса. По умолчанию — 0
  • limit  — количество записей для выборки. По умолчанию — 25
  • usr_id — ID пользователя (можно взять из объекта, возвращаемого при авторизации или инициализации)
  • acc_id — ID аккаунта (тоже берётся при авторизации/инициализации)
 

Пример запроса

fetch("https://tasks.<server_address>/backend/public/dictionary/initiators?_dc=1597911482387&page=1&start=0&limit=25
&sort=%5B%7B%22property%22%3A%22id%22%2C%22direction%22%3A%22ASC%22%7D%5D", {
  method: "GET",
  headers: {
    "accept": "*/*",
    "accept-language": "uk-UA,uk;q=0.9,ru;q=0.8,en-US;q=0.7,en;q=0.6",
    "x-csrf-token": "<your_csrf_token>"
  },
  credentials: "include"
})
 
Ответ
{
  "page": 1,
  "items": [
    {
      "id": 1,
      "c_name": "Template Name",
      "c_parameters": {...},
      "c_information": {...},
      "created_at": 1597911482,
      "updated_at": 1597911482,
      "is_default": true
    }
  ],
  "total": 10
}
В ответ на API-запрос возвращается:
  • id — идентификатор шаблона
  • c_name — название шаблона
  • c_parameters — параметры шаблона
  • c_information — дополнительная информация по шаблону
  • created_at — время создания записи на сервере
  • updated_at — время последнего обновления записи
  • is_default — признак шаблона по умолчанию