General domain settings (settings)

Table of Contents

Requests

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/domain/settings`	Getting a list of settings
`GET`	`/rest/v1/domain/settings/<key>`	Retrieving setup data
`PATCH`	`/rest/v1/domain/settings/<key>`	Changing the setting data

GET

/rest/v1/domain/settings

Getting a list of settings

GET

/rest/v1/domain/settings/<key>

Retrieving setup data

PATCH

/rest/v1/domain/settings/<key>

Changing the setting data

Getting a list of settings

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: key.
`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/domain/settings?offset=0&limit=2 HTTP/1.1

Response

Field Description: setting entity

Response example

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

[
  {
    "key": "alertcall_defaults",
    "value": {
      "attemptcount": 1,
      "attempttimeoutsec": 10,
      "callerid": "100",
      "callername": "AlertMachine",
      "calltimeout": 30,
      "trunkcount": 1
    }
  }
]

Retrieving setup data

Request

Table 2. Request parameters
Name	Type	Description
`mask`	`str`	A list of fields to output.
`flat`	`bool`	Conversion to flat form of composite fields.

Request example

GET /rest/v1/domain/settings/licowned HTTP/1.1

Response

Field Description: setting entity

Response example

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

{
  "key": "licowned",
  "value": {
    "devices": 100,
    "domains": 20,
    "ivrscripts": 10,
    "sipqueue": 0,
    "siptrunks": 200,
    "solution_era": 20,
    "svcscripts": 10,
    "userqueue": 0,
    "webservice_public": 5,
    "webservice_subscr": 1
  }
}

Changing the setting data

Fields prohibited for modification: key

Request

Field Description: setting entity

Request example

PATCH /rest/v1/domain/settings/licowned HTTP/1.1
Content-Type: application/json; charset=utf-8

setting entity

Response

Field Description: setting entity

Response example

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

{
  "key": "licowned",
  "value": {
    "devices": 120,
    "domains": 20,
    "ivrscripts": 10,
    "sipqueue": 0,
    "siptrunks": 200,
    "solution_era": 20,
    "svcscripts": 10,
    "userqueue": 0,
    "webservice_public": 5,
    "webservice_subscr": 1
  }
}