correlation.update

説明

object correlation.update(object/array correlations)

このメソッドは、既存の相関関係を更新することができます。

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

パラメーター

(object/array) 更新する相関関係プロパティ。

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

標準相関プロパティに加えて、このメソッドは次のパラメーターを受け入れます。

パラメーター タイプ 説明
filter object 現在のフィルターを置き換える相関関係フィルターオブジェクト。
operations array 既存の操作を置き換える相関関係操作。

戻り値

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

例

相関関係の無効化

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "correlation.update",
    "params": {
        "correlationid": "1",
        "status": "1"
    },
    "id": 1
}

レスポンス:

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

評価方法を維持したままで条件の置き換え

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "correlation.update",
    "params": {
        "correlationid": "1",
        "filter": {
            "conditions": [
                {
                    "type": 3,
                    "oldtag": "error",
                    "newtag": "ok"
                }
            ]
        }
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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