API リクエスト本文でフィルタリング

フィルタリングは、Web ページを処理するときに、ベーシックな条件付きのクエリーとページ操作を提供します。フィルタリングにはフィルタリングの条件、列の並び替え、改ページ パラメーターという 3 つの基本的な機能があります。

Automation Anywhere API で使用される JSON フィルタリング構造の表現です。
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}
この JSON オブジェクトの最も基本的な部分はフィルター配列です。

フィルターについて

基本フィルター
フィルターは、1 つの条件の検索に使用できます。または、論理オペランド AND および OR でラップすることもできます。フィルタリングは、単一のフィールドの単純な条件付き評価にすることができます。フィルターで使用される演算子、フィールド、および値は、使用される API に固有です。
注: 山括弧内の値 < > には、すべての潜在的な値のリストが含まれます。各パラメーターには 1 つの値のみが必要です。
単一パラメーター フィルター
{
  "filter": {
    "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
    "field": "string",
    "value": "string"
  }
}
2 つのパラメーター フィルター
{
  "filter": {
    "operator": "<and, or>",
    "operands": [
      {
        "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
        "field": "string",
        "value": "string"
      },
      {
        "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
        "field": "string",
        "value": "string"
      }
    ]
  }
}
ページ
"page":{ 
    "offset":0,
    "length":0
}
改ページ ルール パラメーター
  • オフセット:

    タイプ: 整数

    フィルタリングによって評価が開始される、テーブル内の行数を示す値です。

  • 長さ

    タイプ: 整数

    1 つのページの結果で返された行数です。

ソート
 "sort": [
    {
      "field": "string",
      "direction": "<asc, desc>"
    }
  • フィールド: 結果をフィルターするフィールド。これは、サポートされているフィルター可能なフィールドでなければなりません。フィルター可能なフィールドは API によって異なります。
  • 方向

    タイプ: Enum [ desc, asc ]

    • asc = 昇順 (小から大、0 から 9、A から Z)
    • asc = 降順 (大から小、9 から 0、Z から A)

API フィルタの例

createdOn と userName フィールドを使った監査 API フィルターの例
特定の日付範囲で userName に特定の文字列を持つユーザーのエントリを監査ログから探すフィルターを作成します。