Topology (topology)

Table of Contents

Requests
Related Composite Resources

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/uc/selectors/<id>/topology`	Obtaining topology
`PATCH`	`/rest/v1/uc/selectors/<id>/topology`	Topology change
`DELETE`	`/rest/v1/uc/selectors/<id>/topology`	Resetting topology to initial state

GET

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

Obtaining topology

PATCH

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

Topology change

DELETE

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

Resetting topology to initial state

Obtaining topology

Features

The topology is returned by the server as a list of modifiers relative to the null state.
The list of modifiers may differ from the actual sequence of modification rules applied.
The list of modifiers is represented as a field value "items".

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 be issued.
`limit`	`int`	The maximum number of resources in the list.
`order`	`array<object\|str>`	The sort order of the resources in the list.
`flat`	`bool`	Conversion to flat form of composite fields.

Details about the format of GET request parameters

Request example

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

Response

Field Description: selector’s topology entity

Response example

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

Topology change

Features

The topology is established by imposing a sequence of rules for activation/deactivation of voice streams. Each rule determines the activation/deactivation of a voice stream from subscriber "a" to subscriber "b". As a result of applying each rule, the topology comes to a new state.
Topology changes can only be made during conference call activity and only over subscribers that are connected to the conference call.
Specifying the "a" or "b" side of a rule with an "*" applies it subsequently to participants who will be connected later as well.

Request

Field Description: selector’s topology entity

Request example

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

Response example

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 topology to initial state

Features

After a reset, the topology always goes to a null state, i.e., no voice exchange at all.

Request

Request example

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

Response

Response example

HTTP/1.1 200 OK

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

Related Composite Resources

Parent: selectors meetings