过滤、分页和排序

Automation 360

关闭内容

内容

打开内容

下载 PDF

过滤、分页和排序

这 Control Room API 支持对返回资源数组的端点进行过滤、分页和排序。

过滤机制过滤需要的资源，排序机制将资源按顺序排列；然后分页机制返回这些有序资源的特定范围。本主题为您提供对 API 请求的结果进行过滤和排序的详细信息，并指导处理从 API 请求返回的大型结果集的分页。

过滤

过滤允许您对返回的资源集合应用布尔条件，以便将集合子集化为仅条件为 true。最基础的操作 Control Room API 过滤器是将字段与给定值进行比较。可以使用 相等比较、 范围比较或逻辑。使用以下运算符将字段与常量值进行比较。


操作	描述	示例
平等比较
情商	等于	用户电子邮件地址，eq first.last@aa.com
氖	不等于	UserEmailAddress, ne first.last@aa.com
范围比较
lt	小于	数量 lt 1500
乐	小于或等于	数量 1500
葛	大于或等于	CreatedDateUtc ge 2021-03-15
gt	大于	CreatedDateUtc 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：如果操作数中的所有条件评估为 truetrue的二元运算符。
or：如果操作数中的至少一个条件计算为 truetrue的二元运算符。

上述图像的 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	offset的起点。默认值为 0。
长度	长度参数是从偏移量开始检索的最大记录数。默认值为 100。

用于分页的 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

过滤、分页和排序

过滤

分页

排序

反馈

在该页