Topology (topology)

Requests

HTTP verb Endpoint Description

GET

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

Getting the topology

PATCH

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

Modifying the topology

DELETE

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

Resetting the topology to the initial state


Getting the topology

Specifics

  • The topology is returned by the server as a list of modifiers relative to the zero state.

  • The modifier list may differ from the actual sequence of applied modification rules.

  • The modifier list is represented as the value of the "items" field.

Request

Table 1. Request parameters
Name Type Description

filter

object

Filter by field values.

mask

str

List of fields to output. Available fields for output: a, b, enables.

offset

int

Offset in the list of resources to output.

limit

int

Maximum number of resources in the list.

order

array<object|str>

Sorting order of resources in the list.

flat

bool

Transformation of composite fields to flat form.

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

Response

Field description: selector’s topology entity

Example response
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
    }
  ]
}

Modifying the topology

Specifics

  • The topology is set by applying a sequence of voice stream activation/deactivation rules. Each rule determines whether the voice stream from participant "a" to participant "b" is enabled. After each rule is applied, the topology enters a new state.

  • The topology can be changed only while the selector meeting is active and only for participants connected to it.

  • Specifying the "a" or "b" side of a rule via "*" subsequently applies it to participants connected later.

Request

Field description: selector’s topology entity

Example request
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
    }
  ]
}

Response

Field description: selector’s topology entity

Example response
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
    }
  ]
}

Resetting the topology to the initial state

Specifics

  • After reset the topology always returns to the zero state, that is, complete absence of voice exchange.

Request

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

Response

Example response
HTTP/1.1 200 OK

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