Filtrado, paginación y clasificación

El filtrado le permite aplicar una condición booleana a una colección de recursos devueltos con el fin de subconjuntar la colección sólo con aquellos recursos para los que la condición es verdadera. La operación más básica en una Control Room API es comparar un campo con un valor determinado. Es posible utilizar comparación de igualdad, comparación de rangoso lógica . Utilice los siguientes operadores para comparar un campo con un valor constante.

Operación	Descripción	Ejemplo:
Comparación de la igualdad
eq	Es igual a	UserEmailAddress, eq first.last@aa.com
ne	No es igual	UserEmailAddress, ne first.last@aa.com
Comparación de la gama
lt	Menor que	Cantidad lt 1500
le	Menor que o igual a	Cantidad le 1500
ge	Mayor que o igual a	CreatedDateUtc ge 2021-03-15
gt	Mayor que	CreatedDateUtc gt 2021-03-15
Lógica
y	Y	Campo1 eq 'abc' y Campo2 eq 'def'
o	O	Campo1 eq 'abc' o Campo2 eq 'def'

El filtro le permite aplicar a una solicitud filtros básicos, múltiples y orientados a las convenciones. Los filtros de las Control Room API se aplican con un solo parámetro o con múltiples parámetros.

El filtro de parámetro único permite que la solicitud de la API seleccione las respuestas haciendo coincidir uno o más miembros de la respuesta con el valor pasado en la consulta. El filtro de un solo parámetro se representa en la siguiente imagen:

El equivalente JSON de la imagen anterior (filtro de un solo parámetro) tiene el siguiente aspecto:

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

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

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

El filtro de parámetros múltiples le permite filtrar los resultados basándose en la combinación de múltiples condiciones envueltas en operandos lógicos y y o.

• and: Un operador binario que se evalúa como verdadero si todas las condiciones de los operandos se evalúan como verdadero.
  
  
• or: Un operador binario que se evalúa como verdadero si al menos una de las condiciones de los operandos se evalúa como verdadero.
  
  

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