correlation.delete

説明

object correlation.delete(array correlationids)

このメソッドは、相関関係を削除することができます。

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

パラメーター

(array) 削除する相関関係のID。

戻り値

(object) correlationidsプロパティの下にある削除された相関関係のIDを含むオブジェクトを返します。

例

複数の相関関係の削除

2つの相関関係を削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "correlation.delete",
    "params": [
        "1",
        "2"
    ],
    "id": 1
}

レスポンス:

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

ソース

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