module.create

Описание

object module.create(объект/массив modules)

Этот метод позволяет устанавливать новые интерфейсные модули.

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

Файлы модулей необходимо распаковать вручную в правильные подкаталоги, соответствующие свойству relative_path модулей.

Параметры

(object/array) Модули для создания.

Метод принимает модули со стандартными свойствами модуля.

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

(object) Возвращает объект, содержащий идентификаторы установленных модулей в свойстве moduleids. Порядок возвращаемых идентификаторов соответствует порядку переданных модулей.

Примеры

Установка модуля

Установите модуль со статусом "Включен".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "module.create",
    "params": {
        "id": "example_module",
        "relative_path": "modules/example_module",
        "status": 1
    },
    "id": 1
}

Ответ:

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

См. также

Исходный код

CModule::create() в ui/include/classes/api/services/CModule.php.