usermacro.updateglobal

説明

object usermacro.updateglobal(object/array globalMacros)

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

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

パラメータ

(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.

Documentation

usermacro.updateglobal

説明

パラメータ

戻り値

例

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

ソース