Служебные задачи (svctasks)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/service/svctasks

Создание новой служебной задачи

GET

/rest/v1/service/svctasks

Получение списка служебных задач

GET

/rest/v1/service/svctasks/<id>

Получение данных служебной задачи

PATCH

/rest/v1/service/svctasks/<id>

Изменение данных служебной задачи

DELETE

/rest/v1/service/svctasks/<id>

Удаление служебной задачи

LOOKUP

/rest/v1/service/svctasks

Поиск идентификатора служебного сценария

Создание новой служебной задачи

Запрос

Описание полей: svctask entity

Пример запроса
POST /rest/v1/service/svctasks HTTP/1.1
Content-Type: application/json; charset=utf-8

svctask entity

Ответ

Описание полей: svctask entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "380daae6-016c-cdd4-606e-50e54938780c",
  "name": "Обзвон должников",
  "isenabled": 0,
  "svcscriptcode": "dialByCallList",
  "sitemode": "all",
  "sites": "",
  "isregular": 1,
  "overlap": 1,
  "intervalsec": 3600,
  "dtstart": "2019-02-20T08:00:00Z",
  "dtstop": "2020-02-20T08:00:00Z",
  "schedule": "work",
  "periods": [],
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-26T12:09:03.34Z",
    "lwt": "2019-08-26T12:09:03.34Z"
  }
}

Получение списка служебных задач

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, name, isenabled, svcscriptcode, sitemode, isregular, overlap, intervalsec, dtstart, dtstop, schedule, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/service/svctasks?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: svctask entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "380daae6-016c-cdd4-606e-50e54938780c",
    "name": "Обзвон должников",
    "isenabled": 0,
    "svcscriptcode": "dialByCallList",
    "sitemode": "all",
    "isregular": 1,
    "overlap": 1,
    "intervalsec": 3600,
    "dtstart": "2019-02-20T08:00:00Z",
    "dtstop": "2020-02-20T08:00:00Z",
    "schedule": "work",
    "ext": {
      "ct": "2019-08-26T12:09:03.34Z",
      "lwt": "2019-08-26T12:09:03.34Z"
    }
  },
  {
    "id": "86228b15-016c-cdef-ccce-50e54938780c",
    "name": "Очистка ежедневная",
    "isenabled": 1,
    "svcscriptcode": "cleardata",
    "sitemode": "all",
    "isregular": 1,
    "overlap": 1,
    "intervalsec": 86400,
    "dtstart": "2019-02-20T08:00:00Z",
    "dtstop": "2020-02-20T08:00:00Z",
    "schedule": "work",
    "ext": {
      "ct": "2019-08-26T12:39:00.55Z",
      "lwt": "2019-08-26T12:39:00.55Z"
    }
  }
]

Получение данных служебной задачи

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/service/svctasks/380daae6-016c-cdd4-606e-50e54938780c HTTP/1.1

Ответ

Описание полей: svctask entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "380daae6-016c-cdd4-606e-50e54938780c",
  "name": "Обзвон должников",
  "isenabled": 0,
  "svcscriptcode": "dialByCallList",
  "sitemode": "all",
  "sites": "",
  "isregular": 1,
  "overlap": 1,
  "intervalsec": 3600,
  "dtstart": "2019-02-20T08:00:00Z",
  "dtstop": "2020-02-20T08:00:00Z",
  "schedule": "work",
  "periods": [],
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-26T12:09:03.34Z",
    "lwt": "2019-08-26T12:09:03.34Z"
  }
}

Изменение данных служебной задачи

Поля запрещенные для изменения: id

Запрос

Описание полей: svctask entity

Пример запроса
PATCH /rest/v1/service/svctasks/380daae6-016c-cdd4-606e-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

svctask entity

Ответ

Описание полей: svctask entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "380daae6-016c-cdd4-606e-50e54938780c",
  "name": "Обзвон должников",
  "isenabled": 1,
  "svcscriptcode": "dialByCallList",
  "sitemode": "firstsite",
  "sites": "SITE1, SITE2",
  "isregular": 1,
  "overlap": 1,
  "intervalsec": 3600,
  "dtstart": "2019-02-20T08:00:00Z",
  "dtstop": "2020-02-20T08:00:00Z",
  "schedule": "all",
  "periods": [],
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-26T12:09:03.34Z",
    "lwt": "2019-09-10T12:38:40.11Z"
  }
}

Удаление служебной задачи

Запрос

Пример запроса
DELETE /rest/v1/service/svctasks/380daae6-016c-cdd4-606e-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора служебного сценария

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id

Запрос

Пример запроса
LOOKUP /rest/v1/service/svctasks HTTP/1.1
Content-Type: application/json; charset=utf-8

"380daae6-016c-cdd4-606e-50e54938780c"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "380daae6-016c-cdd4-606e-50e54938780c"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}
  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт