correlation.get
説明
integer/array correlation.get(object parameters)
このメソッドは、指定したパラメーターに応じた相関関係を取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object) 希望する出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートしています。
| パラメーター | Type | 説明 |
|---|---|---|
| correlationids | ID/array | 指定されたIDの相関のみを返します。 |
| selectFilter | query | 相関条件のfilterプロパティを返します。 |
| selectOperations | query | 相関条件のoperationsプロパティを返します。 |
| sortfield | string/array | 与えられたプロパティで結果を並べ替えます。 可能な値: correlationid、name、status。 |
| countOutput | boolean | これらのパラメーターについては、リファレンスの解説で解説されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
相関関係の取得
設定されたすべての相関を、相関条件および操作とともに取得します。
フィルターは"and/or"評価タイプを使用するため、formulaプロパティは空で、eval_formulaが自動的に生成されます。
{
"jsonrpc": "2.0",
"method": "correlation.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectFilter": "extend"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"correlationid": "1",
"name": "Correlation 1",
"description": "",
"status": "0",
"filter": {
"evaltype": "0",
"formula": "",
"conditions": [
{
"type": "3",
"oldtag": "error",
"newtag": "ok",
"formulaid": "A"
}
],
"eval_formula": "A"
},
"operations": [
{
"type": "0"
}
]
}
],
"id": 1
}参照
ソース
CCorrelation::get() in ui/include/classes/api/services/CCorrelation.php.