Правила записи (recordrules)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/recordrules

Создание нового правила

GET

/rest/v1/uc/recordrules

Получение списка правил

GET

/rest/v1/uc/recordrules/<id>

Получение данных правила

PATCH

/rest/v1/uc/recordrules/<id>

Изменение данных правила

DELETE

/rest/v1/uc/recordrules/<id>

Удаление правила

LOOKUP

/rest/v1/uc/recordrules

Поиск идентификатора правила записи


Создание нового правила

Запрос

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

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

recordrule entity

Ответ

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

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

{
  "id": "cdffb0ae-016c-d2b3-e556-50e54938780c",
  "priority": 99,
  "dir": "",
  "fromnumber": "",
  "tonumber": "",
  "crossdomain": "",
  "rec": 1,
  "storageruleid": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
  "schedule": "work",
  "periods": [],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2019-08-27T10:51:40.75Z",
    "lwt": "2019-08-27T10:51:40.75Z"
  }
}

Получение списка правил

Запрос

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

filter

object

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

mask

str

Список полей для вывода. Доступные поля для выдачи: id, priority, dir, fromnumber, tonumber, crossdomain, rec, storageid, schedule, opts.title, ext.lwt, ext.ct.

offset

int

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

limit

int

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

order

array<object|str>

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

flat

bool

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

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

Ответ

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

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

[
  {
    "id": "06839f04-016c-d2b4-70ce-50e54938780c",
    "priority": 50,
    "dir": "incoming",
    "fromnumber": "",
    "tonumber": "",
    "crossdomain": "",
    "rec": 1,
    "storageruleid": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
    "schedule": "work",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-27T10:52:16.46Z",
      "lwt": "2019-08-27T10:52:16.46Z"
    }
  },
  {
    "id": "cdffb0ae-016c-d2b3-e556-50e54938780c",
    "priority": 99,
    "dir": "",
    "fromnumber": "",
    "tonumber": "",
    "crossdomain": "*",
    "rec": 1,
    "storageruleid": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
    "schedule": "work",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-27T10:51:40.75Z",
      "lwt": "2019-08-27T10:51:40.75Z"
    }
  }
]

Получение данных правила

Запрос

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

mask

str

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

flat

bool

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

Пример запроса
GET /rest/v1/uc/recordrules/cdffb0ae-016c-d2b3-e556-50e54938780c HTTP/1.1

Ответ

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

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

{
  "id": "cdffb0ae-016c-d2b3-e556-50e54938780c",
  "priority": 99,
  "dir": "",
  "fromnumber": "",
  "tonumber": "",
  "crossdomain": "",
  "rec": 1,
  "storageruleid": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
  "schedule": "work",
  "periods": [],
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-27T10:51:40.75Z",
    "lwt": "2019-08-27T10:51:40.75Z"
  }
}

Изменение данных правила

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

Запрос

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

Пример запроса
PATCH /rest/v1/uc/recordrules/cdffb0ae-016c-d2b3-e556-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

recordrule entity

Ответ

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

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

{
  "id": "cdffb0ae-016c-d2b3-e556-50e54938780c",
  "priority": 99,
  "dir": "inner",
  "fromnumber": "101",
  "tonumber": "115",
  "crossdomain": "*",
  "rec": 0,
  "storageruleid": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
  "schedule": "all",
  "periods": [],
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-27T10:51:40.75Z",
    "lwt": "2019-09-09T09:38:59.35Z"
  }
}

Удаление правила

Запрос

Пример запроса
DELETE /rest/v1/uc/recordrules/cdffb0ae-016c-d2b3-e556-50e54938780c HTTP/1.1

Ответ

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

Поиск идентификатора правила записи

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

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

Запрос

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

"cdffb0ae-016c-d2b3-e556-50e54938780c"

Ответ

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

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

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}