Правила представления (representatives)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/representatives

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

GET

/rest/v1/uc/representatives

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

GET

/rest/v1/uc/representatives/<id>

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

PATCH

/rest/v1/uc/representatives/<id>

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

DELETE

/rest/v1/uc/representatives/<id>

Удаление правила представления

LOOKUP

/rest/v1/uc/representatives

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

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

Запрос

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

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

representative entity

Ответ

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

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

{
  "id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
  "priority": 76,
  "dir": "cross",
  "ofdomain": "$.rootdomain.ru",
  "ofnumber": "XXX",
  "ofusername": "",
  "fordomain": "",
  "fornumber": "",
  "forusername": "",
  "action": "apply",
  "modifier": "5T",
  "moddisplay": "*",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T07:54:09.62Z",
    "lwt": "2019-08-28T07:54:09.62Z"
  }
}

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

Запрос

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

filter

object

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

mask

str

Список полей для вывода. Доступные поля для выдачи: id, priority, dir, ofdomain, ofusername, ofnumber, fordomain, forusername, fornumber, action, modifier, opts.title, ext.lwt, ext.ct.

offset

int

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

limit

int

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

order

array<object|str>

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

flat

bool

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

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

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

Ответ

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

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

[
  {
    "id": "4f3fc6d5-016c-d738-96f2-50e54938780c",
    "priority": 75,
    "dir": "inner",
    "ofdomain": "",
    "ofnumber": "XXX",
    "ofusername": "",
    "fordomain": "$.rootdomain.ru",
    "fornumber": "",
    "forusername": "",
    "action": "apply",
    "modifier": "7XXX",
    "moddisplay": "",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T07:55:05.84Z",
      "lwt": "2019-08-28T07:55:05.84Z"
    }
  },
  {
    "id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
    "priority": 76,
    "dir": "cross",
    "ofdomain": "$.rootdomain.ru",
    "ofnumber": "XXX",
    "ofusername": "",
    "fordomain": "",
    "fornumber": "",
    "forusername": "",
    "action": "apply",
    "modifier": "5T",
    "moddisplay": "",
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-28T07:54:09.62Z",
      "lwt": "2019-08-28T07:54:09.62Z"
    }
  }
]

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

Запрос

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

mask

str

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

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/uc/representatives/9b64ae6e-016c-d737-bb5c-50e54938780c HTTP/1.1

Ответ

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

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

{
  "id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
  "priority": 76,
  "dir": "cross",
  "ofdomain": "$.rootdomain.ru",
  "ofnumber": "XXX",
  "ofusername": "",
  "fordomain": "",
  "fornumber": "",
  "forusername": "",
  "action": "apply",
  "modifier": "5T",
  "moddisplay": "*",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T07:54:09.62Z",
    "lwt": "2019-08-28T07:54:09.62Z"
  }
}

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

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

Запрос

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

Пример запроса
PATCH /rest/v1/uc/representatives/9b64ae6e-016c-d737-bb5c-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

representative entity

Ответ

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

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

{
  "id": "9b64ae6e-016c-d737-bb5c-50e54938780c",
  "priority": 77,
  "dir": "cross",
  "ofdomain": "test.rootdomain.ru",
  "ofnumber": "XXX",
  "ofusername": "",
  "fordomain": "",
  "fornumber": "",
  "forusername": "",
  "action": "apply",
  "modifier": "35T",
  "moddisplay": "*",
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-28T07:54:09.62Z",
    "lwt": "2019-09-09T08:56:14.39Z"
  }
}

Удаление правила представления

Запрос

Пример запроса
DELETE /rest/v1/uc/representatives/9b64ae6e-016c-d737-bb5c-50e54938780c HTTP/1.1

Ответ

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

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

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

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

Запрос

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

"4f3fc6d5-016c-d738-96f2-50e54938780c"

Ответ

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

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

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