usermacro.update

説明

object usermacro.update(object/array hostMacros)

このメソッドを使用すると、既存のホストマクロを更新できます。

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

パラメータ

(object/array) 更新するホストマクロプロパティ

ホストマクロごとにhostmacroidプロパティを定義する必要があります。他のプロパティはすべてオプションです。渡されたプロパティのみが更新され、他のプロパティは変更されません。

戻り値

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

例

ホストマクロの値変更

ホストマクロの値を"public"に変更します。

Request:

{
           "jsonrpc": "2.0",
           "method": "usermacro.update",
           "params": {
               "hostmacroid": "1",
               "value": "public"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

ソース

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

Documentation

usermacro.update

説明

パラメータ

戻り値

例

ホストマクロの値変更

ソース