API 请求正文中的筛选器
筛选提供处理 API 请求的基本条件查询和 API 请求。有三个基本组件可供筛选：条件、排序和分页参数。
以下是 Automation Anywhere API 中使用的 JSON 筛选结构的表示。
{
"filter": {
"operator": "NONE",
"operands": [
null
],
"field": "string",
"value": "string"
},
"sort": [
{
"field": "string",
"direction": "asc"
}
],
"page": {
"offset": 0,
"length": 0
}
}了解筛选器
- 基本筛选器
-
筛选器可用于搜索单个条件，也可以用逻辑操作数 AND 和 OR 来包装。筛选可以是单个字段的简单条件评估。筛选器中使用的运算符、字段和值特定于它们所使用的 API。注： 尖括号中的值 < > 包括所有潜在值的列表。每个参数只能有一个值。
- 单参数筛选器
-
{ "filter": { "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>", "field": "string", "value": "string" } } - 双参数筛选器
-
{ "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 }分页规则参数- 偏移：
类型：整数
指示筛选器开始评估的表格行数的数值。
- Length
类型：整数
单页结果中返回的行数。
- 偏移：
- 排序
-
"sort": [ { "field": "string", "direction": "<asc, desc>" }
API 筛选器示例
- 用户管理筛选器示例
- 此示例筛选器基于用户管理 API 字段和参数。此筛选器用于搜索用户的登录名、用户名和用户的真实名称 firstName。
- 存储库管理筛选器示例
- 此示例筛选器基于存储库管理 API 字段和参数。此筛选器示例搜索 bot 状态和名称。
- 迁移列表结果筛选器示例
- 此示例筛选器基于迁移 API 字段和参数。此筛选器用于搜索名称中包含特定字符串并已启动、在两个日期之间已更新的迁移。