ユーザー管理のフィルター例

このフィルター例は、ユーザー管理の API フィールドとパラメーターに基づいています。このフィルターは、ユーザー名とユーザーの名前を検索します。

このフィルターは、username フィールドの文字列 bot-creator とfirstName フィールドの文字列 Adweta を検索します。
{
  "sort": [
    {
      "field": "username",
      "direction": "asc"
    }
  ],
  "filter": {
    "operator": "and",
    "operands": [
      {
        "operator": "substring",
        "value": "bot-creator",
        "field": "username"
      },
      {
        "operator": "substring",
        "value": "Adweta",
        "field": "firstName"
      }
    ]
  }
}
ソート
  • フィールド: レスポンスのソートに使用するフィールドの名前。
  • 方向: ソート順序。asc昇順、またはdesc降順を指定できます。
フィルター

フィルターは、演算子と値、フィールドで構成されます。フィルターは、 または などの boolean 演算子と組み合わせた場合の演算子になります。

  • 演算子: フィルターは、フィルターでブール演算子と組み合わせると演算子として使用されます。使用可能なブール演算子は 2 つあります。
    • OR: いずれかの条件を満たす。
    • AND: すべての条件を満たす。
  • 演算子:11個の演算子があります (NONE、LT、LE、EQ、NE、GE、GT、substring、AND、OR、NOT）。AND と OR は、複数のフィルターの組み合わせを評価するために使用されます。他の演算子は、個々のフィルター内の値の評価に使用されます。すべてのフィールドですべての演算子を使用できるわけではありません。
  • フィールド: フィルターで使用されるフィールドの名前。
  • 値: 評価されるフィールドの値。