篩選、分頁和排序

這 Control Room API 支持對返回資源數組的端點進行過濾、分頁和排序。

過濾機製過濾需要的資源，排序機制對資源進行排序；然後分頁機制返回這些有序資源的特定範圍。本主題為您提供了過濾和排序 API 請求結果的詳細信息，還提供了處理 API 請求返回的大型結果集分頁的指南。

註:

子字符串支持排序和過濾。例如，如果你想搜索 bots 或名稱中包含 fin 的文件，輸入 fin 作為搜索條件。一切 bots 將顯示名稱中包含 fin
搜索和過濾不支持通配符 bots 或文件。

過濾

過濾允許您對返回資源的集合應用布爾條件，以便將該集合子集化為僅條件為 真的。最基本的操作 Control Room API 過濾器是將字段與給定值進行比較。可以使用 相等比較、 範圍比較或邏輯。使用以下運算符將字段與常量值進行比較。


作業	說明	範例
平等比較
當量	等於	用戶郵箱地址，eq first.last@aa.com
無	不等於	UserEmailAddress，ne first.last@aa.com
範圍比較
lt	小於	數量lt 1500
樂	小於或等於	數量 le 1500
格	大於或等於	創建日期 Utc ge 2021-03-15
GT	大於	創建日期 Utc gt 2021-03-15
合乎邏輯
和	和	Field1 eq 'abc' 和 Field2 eq 'def'
或	或	Field1 eq 'abc' 或 Field2 eq 'def'

filter將基本的、多重的和麵向約定的過濾器應用於請求。中的過濾器 Control Room API 應用單個參數或多個參數。

單參數過濾器

單參數過濾器允許 API 請求通過將響應的一個或多個成員與查詢中傳遞的值相匹配來選擇響應。單參數過濾器如下圖所示：

上圖的 JSON 等價物（單參數過濾器）如下所示：

{
  "filter": {
    "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
    "field": "string",
    "value": "string"
  }
}

例如，要列出具有子字符串 finance，請使用以下單參數過濾器：

POST http://{{ControlRoomURL}}/v2/devices/pools/list

{
   "filter":{
      "operator":"substring",
      "field":"name",
      "value":"finance"
   }
}

有關單個參數過濾器的更多詳細示例，請參閱列出設備池 API.

多參數過濾器

and 和 or中的多個條件組合來過濾結果。

and：如果操作數中的所有條件的計算結果都為 真真的二元運算符。
or：一個二元運算符，如果操作數中至少有一個條件的計算結果為 true ，則計算結果 為true。

上圖的 JSON 等價物（多參數過濾器）如下所示：

{
  "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"
      }
    ]
  }
}

例如，要列出具有子字符串 Device， createdOn 在 2022-04-01， createdOn2022-05-31 之前，使用帶有邏輯 加 運算符的多參數過濾，如下所示：

POST http://{{ControlRoomURL}}//v1/usermanagement/roles/list

{
   "filter":{
      "operator":"and",
      "operands":[
         {
            "operator":"substring",
            "field":"name",
            "value":"Device"
         },
         {
            "operator":"gt",
            "field":"createdOn",
            "value":"2022-04-01T00:00:00.989Z"
         },
         {
            "operator":"lt",
            "field":"createdOn",
            "value":"2022-05-31T23:00:00.123Z"
         }
      ]
   }
   }

有關單個參數過濾器的更多詳細示例，請參閱列出角色.

分頁

分頁允許您：

檢索有限的結果集合。
偏移結果集合。

全部 Control Room 返回記錄集合的 API 是分頁的。支持分頁的 API 方法有兩個（可選）參數：


作業	說明
偏移	offset的起點。默認值為 0。
長度	長度參數是從偏移量開始檢索的最大記錄數。默認值為 200。

用於分頁的 JSON 片段如下所示：

"page":{ 
    "offset":5,
    "length":10
}

有關單個參數過濾器的更多詳細示例，請參閱列出角色.

排序

排序允許您按任何字段按升序或降序對結果進行排序。例如，如果要返回角色，則可以按上次修改日期對角色進行排序。

 "sort": [
    {
      "field": "string",
      "direction": "<asc, desc>"
    }

方向

類型：枚舉 [desc, asc]

asc = 升序（從最小到最大，0 到 9，A 到 Z）
desc = 降序（從大到小，9 到 0，Z 到 A）

有關單個參數過濾器的更多詳細示例，請參閱列出角色.

Automation 360