usermacro.updateglobal

説明

object usermacro.updateglobal(object/array globalMacros)

このメソッドを使用すると、既存のグローバルマクロを更新できます。

このメソッドは、Super admin ユーザータイプでのみ利用できます。 このメソッドを呼び出す権限は、ユーザー権限設定で取り消すことができます。詳細は User roles を参照してください。

パラメータ

更新する (object/array) グローバルマクロのプロパティ。

各グローバルマクロでは globalmacroid プロパティを定義する必要があり、その他のプロパティはすべて任意です。渡されたプロパティのみが更新され、それ以外は変更されません。

戻り値

(object) globalmacroids プロパティの下で更新されたグローバル マクロの ID を含むオブジェクトを返します。

例

グローバルマクロの値の変更

グローバルマクロの値を"public"に変更します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "usermacro.updateglobal",
    "params": {
        "globalmacroid": "1",
        "value": "public"
    },
    "id": 1
}

レスポンス:

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

ソース

CUserMacro::updateGlobal() in ui/include/classes/api/services/CUserMacro.php.