[comment]: # ({2ccfd922-2ccfd922})
# event.acknowledge

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

[comment]: # ({07725e16-eed7fdda})
### 説明

`object event.acknowledge(object/array parameters)`

このメソッドを使用すると、イベントを更新できます。実行できる更新アクションは次のとおりです。

-   イベントをクローズします。イベントがすでに解決済みの場合、このアクションはスキップされます。
-   イベントを確認済みにします。イベントがすでに確認済みの場合、このアクションはスキップされます。
-   イベントの確認を解除します。イベントが確認済みでない場合、このアクションはスキップされます。
-   メッセージを追加します。
-   イベントの重大度を変更します。イベントがすでに同じ重大度である場合、このアクションはスキップされます。
-   イベントを抑制します。イベントがすでに抑制されている場合、このアクションはスキップされます。
-   イベントの抑制を解除します。イベントが抑制されていない場合、このアクションはスキップされます。
-   イベントのランクを原因に変更します。イベントがすでに原因としてランク付けされている場合、このアクションはスキップされます。
-   イベントのランクを症状に変更します。イベントがすでに症状としてランク付けされている場合、このアクションはスキップされます。

::: noteimportant
更新できるのはトリガーイベントのみです。<br>
更新できるのは障害イベントのみです。<br>
イベントをクローズする、またはイベントの重大度を変更するには、トリガーに対する読み取り/書き込み権限が必要です。<br>
イベントをクローズするには、トリガーで手動クローズが許可されている必要があります。
:::

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

[comment]: # ({/07725e16-eed7fdda})

[comment]: # ({813f39be-32560b88})
### パラメータ

`(object/array)` イベントのIDと、実行する更新操作を含むパラメータです。

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|eventids|ID/array|確認応答する[イベント](/manual/api/reference/event/object#event)のID。<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *必須*|
|action|integer|イベント更新アクション。<br><br>使用可能なビットマップ値:<br>1 - 障害をクローズ;<br>2 - イベントを確認応答;<br>4 - メッセージを追加;<br>8 - 深刻度を変更;<br>16 - イベントの確認応答を解除;<br>32 - イベントを抑制;<br>64 - イベントの抑制を解除;<br>128 - イベントランクを原因に変更;<br>256 - イベントランクを症状に変更。<br><br>これはビットマスクフィールドです。使用可能なビットマップ値の任意の合計を指定できます（例えば、34 はイベントの確認応答と抑制を意味します）。<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *必須*|
|cause_eventid|ID|原因イベントID。<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- `action` に「イベントランクを症状に変更」ビットが含まれる場合は *必須*|
|message|string|メッセージのテキスト。<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- `action` に「メッセージを追加」ビットが含まれる場合は *必須*|
|severity|integer|イベントの新しい深刻度。<br><br>使用可能な値:<br>0 - 未分類;<br>1 - 情報;<br>2 - 警告;<br>3 - 軽度の障害;<br>4 - 重度の障害;<br>5 - 致命的な障害。<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- `action` に「深刻度を変更」ビットが含まれる場合は *必須*|
|suppress_until|integer|イベントを抑制する期限のUnixタイムスタンプ。<br><br>"0" に設定すると、抑制は無期限になります。<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- `action` に「イベントを抑制」ビットが含まれる場合は *必須*|

[comment]: # ({/813f39be-32560b88})

[comment]: # ({94f3ab84-94f3ab84})
### 戻り値
`(object)` `eventids` プロパティの下で更新されたイベントの ID を含むオブジェクトを返します。

[comment]: # ({/94f3ab84-94f3ab84})

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

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

[comment]: # ({2aa7a118-9e923e4c})
#### イベントの確認

1つのイベントを確認し、メッセージを残します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Problem resolved."
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/2aa7a118-9e923e4c})

[comment]: # ({63d8190d-94e25d7e})
#### イベントの深刻度の変更

複数のイベントの深刻度を変更し、メッセージを残します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Maintenance required to fix it.",
        "severity": 4
    },
    "id": 1
}
```

レスポンス:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427",
            "20428"
        ]
    },
    "id": 1
}
```

[comment]: # ({/63d8190d-94e25d7e})

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

CEvent::acknowledge() in *ui/include/classes/api/services/CEvent.php*.

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