Table of Contents
Correlationオブジェクト
次のオブジェクトは、correlationAPIに直接関連しています。
コリレーション
コリレーションオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| correlationid | ID | コリレーションのID。 プロパティの動作: - 読み取り専用 - 更新操作時に必須 |
| name | string | コリレーションの名前。 プロパティの動作: - 作成操作時に必須 |
| description | string | コリレーションの説明。 |
| status | integer | コリレーションが有効か無効か。 指定可能な値: 0 - (デフォルト) 有効; 1 - 無効。 |
相関操作
相関操作オブジェクトは、相関が実行されたときに実行される操作を定義します。次のプロパティがあります。
コリレーションフィルター
コリレーションフィルターオブジェクトは、設定されたコリレーション操作を実行するために満たす必要がある条件のセットを定義します。 以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| conditions | array | 結果をフィルタリングするために使用するフィルター条件のセット。条件は、式内での配置順にソートされます。 プロパティの動作: - 必須 |
| evaltype | integer | フィルター条件の評価方法。 可能な値: 0 - And/Or; 1 - And; 2 - Or; 3 - カスタム式。 プロパティの動作: - 必須 |
| eval_formula | string | フィルター条件の評価に使用される生成された式。式には、formulaidで特定のフィルター条件を参照するIDが含まれます。eval_formulaの値は、カスタム式のフィルターのformulaの値と等しくなります。プロパティの動作: - 読み取り専用 |
| formula | string | カスタム式のフィルター条件の評価に使用するユーザー定義の式。式には、formulaidで特定のフィルター条件を参照するIDを含める必要があります。式で使用されるIDは、フィルター条件で定義されたものと完全に一致している必要があります。未使用または省略された条件があってはなりません。プロパティの動作: - evaltypeが「カスタム式」に設定されている場合は必須 |
相関フィルター条件
相関フィルター条件オブジェクトは、相関操作を実行する前にチェックする必要がある特定の条件を定義します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| type | integer | 条件のタイプ。 可能な値： 0 - 旧イベントタグ; 1 - 新イベントタグ; 2 - 新イベントホストグループ; 3 - イベントタグペア; 4 - 旧イベントタグ値; 5 - 新イベントタグ値。 プロパティの動作: - 必須 |
| tag | string | イベントタグ（旧または新）。 プロパティの動作: - typeが「旧イベントタグ」、「新イベントタグ」、「旧イベントタグ値」、「新イベントタグ値」に設定されている場合は必須 |
| groupid | ID | ホストグループのID。 プロパティの動作: - typeが「新イベントホストグループ」に設定されている場合は必須 |
| oldtag | string | 旧イベントタグ。 プロパティの動作: - typeが「イベントタグペア」に設定されている場合は必須 |
| newtag | string | 旧イベントタグ。 プロパティの動作: - typeが「イベントタグペア」に設定されている場合は必須 |
| value | string | イベントタグ（旧または新）の値。 プロパティの動作: - typeが「旧イベントタグ値」または「新イベントタグ値」に設定されている場合は必須 |
| formulaid | string | カスタム式から条件を参照するために使用される任意の一意なID。大文字のみ使用可能。フィルター条件を変更する際はユーザーがIDを定義する必要がありますが、その後リクエスト時には新たに生成されます。 |
| operator | integer | 条件演算子。 プロパティの動作: - typeが「新イベントホストグループ」、「旧イベントタグ値」、「新イベントタグ値」に設定されている場合は必須 |
さまざまなタイプの式でフィルターを使用する方法をよりよく理解するには、correlation.getおよびcorrelation.createメソッドページの例を参照してください。
各条件タイプでサポートされる演算子と値は以下の通りです。
| 条件 | 条件名 | サポートされる演算子 | 期待される値 |
|---|---|---|---|
| 2 | ホストグループ | =, <> | ホストグループID |
| 4 | 旧イベントタグ値 | =, <>, like, not like | string |
| 5 | 新イベントタグ値 | =, <>, like, not like | string |