iconmap.update

Описание

object iconmap.update(объект/массив iconMaps)

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

Этот метод доступен только пользователю с типом доступа Супер-администратор. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object/array) Свойства карты значков, которые нужно обновить.

Для каждой карты значков должно быть определено свойство iconmapid, все остальные свойства необязательны. Будут обновлены только переданные свойства, все остальные останутся без изменений.

Помимо стандартных свойств карты значков, метод принимает следующие параметры.

Параметр Тип Описание
mappings array Сопоставления значков для замены существующих сопоставлений значков.

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

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

Примеры

Переименование карты значков

Переименуйте карту значков в "OS icons".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "iconmap.update",
    "params": {
        "iconmapid": "1",
        "name": "OS icons"
    },
    "id": 1
}

Ответ:

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

См. также

Источник

CIconMap::update() в ui/include/classes/api/services/CIconMap.php.