Task templates description

This API allows you to get a list of task templates with their parameters and additional information.

How to get data

Request address

To get the data, use the address: https://tasks.<server_address>/backend/public/dictionary/initiators

Request method

GET

Request parameters

  • page — page number for selection (used for table visualization). Default: 1
  • start — offset for SQL query. Default: 0
  • limit — number of records per request. Default: 25
  • usr_id — user ID (can be taken from the object returned during authorization or initialization)
  • acc_id — account ID (also from authorization/initialization)
 

Example request

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"
})
Response
{
  "page": 1,
  "items": [
    {
      "id": 1,
      "c_name": "Template Name",
      "c_parameters": {...},
      "c_information": {...},
      "created_at": 1597911482,
      "updated_at": 1597911482,
      "is_default": true
    }
  ],
  "total": 10
}
In response to the API request, the following is returned:
  • id — template ID
  • c_name — template name
  • c_parameters — template parameters
  • c_information — additional template information
  • created_at — record creation time on the server
  • updated_at — last update time
  • is_default — indicates if this template is the default