[comment]: # translation:outdated

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

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

[comment]: # ({89a1828a-23e3a148})
### 説明

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

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

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

[comment]: # ({/89a1828a-23e3a148})

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

`(object/array)` 更新する[ホストマクロプロパティ](object#host_macro)

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

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

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

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

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

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

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

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

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

Request:

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

Response:

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

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

[comment]: # ({new-129f453e})
#### Change macro value that was created by discovery rule

Convert discovery rule created "automatic" macro to "manual" and change its value to "new-value".

Request:

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

Response:

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

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

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

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

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