templatescreen.update

Описание

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

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

Параметры

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

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

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

Параметр	Тип	Описание
screenitems	массив	Элементы комплексного эркана, которые заменят существующие элементы комплексного экрана. Элементы комплексного экрана обновляются по координатам, у каждого элемента должны быть заданы свойства `x` и `y`.

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

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

Примеры

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

Переименование комплексного экрана шаблона на "Performance graphs".

Запрос:

{
           "jsonrpc": "2.0",
           "method": "templatescreen.update",
           "params": {
               "screenid": "3",
               "name": "Performance graphs"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

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

Исходный код

CTemplateScreen::update() в frontends/php/api/classes/CTemplateScreen.php.

Documentation