Correlationオブジェクト

次のオブジェクトは、correlationAPIに直接関連しています。

相関関係

相関関係オブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
correlationid ID 相関関係のID。

プロパティの動作:
- 読み取り専用
- 更新操作で必須
name string 相関関係の名前。

プロパティの動作:
- 作成操作で必須
description string 相関関係の説明。
status integer 相関関係が有効か無効か。

指定可能な値:
0 - (デフォルト) 有効;
1 - 無効。

相関関係の操作

相関関係の操作オブジェクトは、相関関係が実行されたときに実行される操作を定義します。以下のプロパティがあります。

Property Type Description
type integer 操作のタイプ。

使用可能な値:
0 - 古いイベントをクローズ;
1 - 新しいイベントをクローズ。

プロパティの動作:
- 必須

相関フィルター

相関フィルターオブジェクトは、設定された相関操作を実行するために満たす必要がある条件のセットを定義します。 次のプロパティがあります。

Property Type Description
conditions array 結果のフィルタリングに使用するフィルター条件のセット。条件は、式内での配置順に並べ替えられます。

Property behavior:
- required
evaltype integer フィルター条件の評価方法。

可能な値:
0 - And/Or;
1 - And;
2 - Or;
3 - カスタム式。

Property behavior:
- required
eval_formula string フィルター条件の評価に使用される生成済みの式。式には、formulaid によって特定のフィルター条件を参照するIDが含まれます。eval_formula の値は、カスタム式を持つフィルターでは formula の値と等しくなります。

Property behavior:
- read-only
formula string カスタム式を持つフィルターの条件評価に使用する、ユーザー定義の式。式には、formulaid によって特定のフィルター条件を参照するIDを含める必要があります。式で使用するIDは、フィルター条件で定義されたものと完全に一致していなければなりません。条件が未使用のまま残ったり、省略されたりしてはいけません。

Property behavior:
- required if evaltype is set to "custom expression"

相関フィルター条件

相関フィルター条件オブジェクトは、相関操作を実行する前に 確認する必要がある特定の条件を定義します。

プロパティ Type 説明
type integer 条件のタイプ。

使用可能な値:
0 - 古いイベントタグ;
1 - 新しいイベントタグ;
2 - 新しいイベントのホストグループ;
3 - イベントタグのペア;
4 - 古いイベントタグ値;
5 - 新しいイベントタグ値。

Property behavior:
- required
tag string イベントタグ（古いまたは新しい）。

Property behavior:
- type が「古いイベントタグ」、「新しいイベントタグ」、「古いイベントタグ値」、または「新しいイベントタグ値」に設定されている場合は required
groupid ID ホストグループのID。

Property behavior:
- type が「新しいイベントのホストグループ」に設定されている場合は required
oldtag string 古いイベントタグ。

Property behavior:
- type が「イベントタグのペア」に設定されている場合は required
newtag string 古いイベントタグ。

Property behavior:
- type が「イベントタグのペア」に設定されている場合は required
value string イベントタグ値（古いまたは新しい）。

Property behavior:
- type が「古いイベントタグ値」または「新しいイベントタグ値」に設定されている場合は required
formulaid string カスタム式から条件を参照するために使用される任意の一意なID。使用できるのは大文字のみです。このIDは、フィルター条件を変更する際にユーザーが定義する必要がありますが、その後に条件を要求すると新たに生成されます。
operator integer 条件演算子。

Property behavior:
- type が「新しいイベントのホストグループ」、「古いイベントタグ値」、または「新しいイベントタグ値」に設定されている場合は required

さまざまな種類の式でフィルターを使用する方法をよりよく理解するには、 correlation.get および correlation.create メソッドの ページにある例を参照してください。

以下の演算子と値が、各条件タイプでサポートされています。

条件 条件名 サポートされる演算子 想定される値
2 ホストグループ =, <> ホストグループID。
4 古いイベントタグ値 =, <>, like, not like string
5 新しいイベントタグ値 =, <>, like, not like string