Filtros en un cuerpo de solicitud de API
El filtrado proporciona consultas condicionales básicas y control de páginas para procesar páginas web. Existen 3 características básicas relacionadas con el filtrado: condiciones de filtrado, columnas de clasificación y parámetros de paginación.
Esta es una representación de la estructura de filtrado JSON utilizada en las API de Automation Anywhere.
{
"filter": {
"operator": "NONE",
"operands": [
null
],
"field": "string",
"value": "string"
},
"sort": [
{
"field": "string",
"direction": "asc"
}
],
"page": {
"offset": 0,
"length": 0
}
}Comprensión de los filtros
- Filtro básico
-
Los filtros se pueden usar para buscar una sola condición o se pueden envolver en operandos lógicos Y y O. El filtrado puede ser una simple evaluación condicional de un solo campo. El operador, el campo y el valor utilizados en un filtro son específicos de la API en la que se utilizan.Nota: Los valores en los corchetes angulares < > incluyen una lista de todos los valores potenciales. Debe haber solo un valor para cada parámetro.
- Filtro de parámetro único
-
{ "filter": { "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>", "field": "string", "value": "string" } } - Filtro de dos parámetros
-
{ "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" } ] } }
- Página
-
"page":{ "offset":0, "length":0 }Parámetros de reglas de paginación- Compensación:
Tipo: entero
El valor numérico que indica cuántas filas en una tabla serán evaluadas por el filtro.
- Largo
Tipo: entero
La cantidad de líneas que se devuelven en una sola página de resultados.
- Compensación:
- Ordenar
-
"sort": [ { "field": "string", "direction": "<asc, desc>" }
Ejemplos de filtros de API
- Ejemplo de filtro de administración de usuarios
- Este filtro de ejemplo se basa en los campos y parámetros de la API de administración de usuarios. Este filtro busca el nombre de inicio de sesión del usuario, username y el nombre real del usuario, firstName.
- Ejemplo de filtro de administración de repositorio
- Este filtro de ejemplo se basa en los campos y parámetros de la API de administración del repositorio. Este ejemplo de filtro busca el bot estado y el nombre.
- Ejemplo de filtro de resultados de lista de migración
- Este filtro de ejemplo se basa en los campos y parámetros de la API de migración. Este filtro busca migraciones que contengan una cadena específica en name y que se haya iniciado, updatedOn, entre dos fechas.