screen.update

Описание

объект screen.update(объект/массив комплексныеЭкраны)

Этот метод позволяет обновлять существующие комплексные экраны.

Параметры

(объект/массив) Свойства комплексных экранов, которые будут обновлены.

Свойство screenid должно быть указано по каждому комплексному экрану, все остальные свойства опциональны. Будут обновлены только переданные свойства, все остальные останутся неизменными.

В дополнение к стандартным свойствам комплексного экрана, этот метод принимает следующие параметры.

Возвращаемые значения

(объект) Возвращает объект, который содержит ID обновленных комплексных экранов под свойством screenids.

Примеры

Переименование комплексного экрана

Переименование комплексного экрана на "CPU Graphs".

Запрос:

{
           "jsonrpc": "2.0",
           "method": "screen.update",
           "params": {
               "screenid": "26",
               "name": "CPU Graphs"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": {
               "screenids": [
                   "26"
               ]
           },
           "id": 1
       }

Смотрите также

• Элемент комплексного экрана
• screenitem.create
• screenitem.update
• screenitem.updatebyposition

Исходный код

CScreen::update() в frontends/php/include/classes/api/services/CScreen.php.