module.update

説明

object module.update(object/array modules)

このメソッドは、既存のモジュールを更新します。

このメソッドは、スーパー管理者ユーザータイプでのみ使用できます。 このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳しくは、ユーザーの役割 をご覧ください。

パラメータ

(object/array) 更新するモジュールプロパティ

moduleid プロパティは各モジュールで定義する必要があります。その他のプロパティはオプションです。 指定されたプロパティのみが更新されます。

このメソッドは、標準モジュールプロパティ を持つモジュールを受け入れます。

戻り値

(object) moduleids プロパティに更新されたモジュールの ID を含むオブジェクトを返します。

例

モジュールの無効化

モジュール"25"を無効化します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "module.update",
    "params": {
        "moduleid": "25",
        "status": 0
    },
    "id": 1
}

レスポンス :

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

参照

ソース

CModule::update() in ui/include/classes/api/services/CModule.php.