iconmap.update

Описание

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

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

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

Параметры

(object/array) Свойства карты иконок, которые необходимо обновить.

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

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

Параметр Type Описание
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.