Топология (topology)

Содержание

Запросы
Связанные композитные ресурсы

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`GET`	`/rest/v1/uc/selectors/<id>/topology`	Получение топологии
`PATCH`	`/rest/v1/uc/selectors/<id>/topology`	Изменение топологии
`DELETE`	`/rest/v1/uc/selectors/<id>/topology`	Сброс топологии в начальное состояние

GET

/rest/v1/uc/selectors/<id>/topology

Получение топологии

PATCH

/rest/v1/uc/selectors/<id>/topology

Изменение топологии

DELETE

/rest/v1/uc/selectors/<id>/topology

Сброс топологии в начальное состояние

Получение топологии

Особенности

Топология возвращается сервером в виде списка модификаторов относительно нулевого состояния.
Список модификаторов может отличаться от реальной последовательности примененных правил модификации.
Список модификаторов представляется в виде значения поля "items".

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`filter`	`object`	Фильтр по значениям полей.
`mask`	`str`	Список полей для вывода. Доступные поля для выдачи: a, b, enables.
`offset`	`int`	Смещение в списке ресурсов, подлежащих выдаче.
`limit`	`int`	Максимальное количество ресурсов в списке.
`order`	`array<object\|str>`	Порядок сортировки ресурсов в списке.
`flat`	`bool`	Преобразование в плоский вид составных полей.

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

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

GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/topology HTTP/1.1

Ответ

Описание полей: selector’s topology entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "items": [
    {
      "a": "",
      "b": "",
      "enabled": false
    },
    {
      "a": "eb3864c3-016d-5d75-9544-50e54938780c",
      "b": "",
      "enabled": false
    },
    {
      "a": "61c0b3aa-016d-61e6-0f67-50e54938780c",
      "b": "",
      "enabled": true
    },
    {
      "a": "83d41cb6-016d-5d75-6341-50e54938780c",
      "b": "*",
      "enabled": true
    }
  ]
}

Изменение топологии

Особенности

Топология устанавливается путем наложения последовательности правил активации/деактивации голосовых потоков. Каждое правило определяет включенность/выключенность голосового потока от абонента "a" к абоненту "б". В результате применения каждого правила, топология приходит в новое состояние.
Изменение топологии возможно только во время активности селекторного совещания и только над абонентами, которые подключены к нему.
Указание стороны "a" или "b" правила через "*" применяет впоследствии его и к участникам, которые будут подключены позднее.

Запрос

Описание полей: selector’s topology entity

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

PATCH /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/topology HTTP/1.1
Content-Type: application/json; charset=utf-8

{
  "changes": [
    {
      "a": "83d41cb6-016d-5d75-6341-50e54938780c",
      "b": "*",
      "enabled": true
    }
  ]
}

Ответ

Описание полей: selector’s topology entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "items": [
    {
      "a": "",
      "b": "",
      "enabled": false
    },
    {
      "a": "eb3864c3-016d-5d75-9544-50e54938780c",
      "b": "",
      "enabled": false
    },
    {
      "a": "61c0b3aa-016d-61e6-0f67-50e54938780c",
      "b": "",
      "enabled": true
    },
    {
      "a": "83d41cb6-016d-5d75-6341-50e54938780c",
      "b": "*",
      "enabled": true
    }
  ]
}

Сброс топологии в начальное состояние

Особенности

После сброса топология всегда приходит в нулевое состояние, то есть полное отсутствие голосового обмена.

Запрос

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

DELETE /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/topology HTTP/1.1

Ответ

Пример ответа

HTTP/1.1 200 OK

{
  "items": [
    {
      "a": "",
      "b": "",
      "enabled": false
    }
  ]
}

Связанные композитные ресурсы

Родительский: cелекторные совещания