[comment]: # ({2ed6e81f-2ed6e81f})
# usermacro.update

[comment]: # ({/2ed6e81f-2ed6e81f})

[comment]: # ({418ab7e0-23e3a148})
### 説明

`object usermacro.update(object/array hostMacros)`

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

::: noteclassic
このメソッドは、*Admin* および *Super admin* ユーザータイプでのみ利用できます。メソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。詳細は、[ユーザーロール](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/418ab7e0-23e3a148})

[comment]: # ({495251b4-f8ce947c})
### パラメータ

更新する `(object/array)` [ホストマクロのプロパティ](object#host-macro)。

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

[comment]: # ({/495251b4-f8ce947c})

[comment]: # ({5e19fc38-5e19fc38})
### 戻り値

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

[comment]: # ({/5e19fc38-5e19fc38})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({985ee438-bc8ce678})
#### ホストマクロの値の変更

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

[リクエスト](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.update",
    "params": {
        "hostmacroid": "1",
        "value": "public"
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/985ee438-bc8ce678})

[comment]: # ({6948283e-129f453e})
#### 検出ルールによって作成されたマクロの値を変更します

検出ルールによって作成された"自動"マクロを"手動"マクロに変換し、その値を"新しい値"に変更します。

[リクエスト](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "usermacro.update",
    "params": {
        "hostmacroid": "1",
        "value": "new-value",
        "automatic": "0"
    },
    "id": 1
}
```

Response:

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

[comment]: # ({/6948283e-129f453e})

[comment]: # ({2eddd7d2-2eddd7d2})
### ソース

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

[comment]: # ({/2eddd7d2-2eddd7d2})