Sintaxis de consulta en solicitudes GET

Puede filtrar los objetos que desea recuperar especificando una consulta como valor del parámetro de consulta de búsqueda en las solicitudes GET. Los resultados se devuelven como una página de objetos en un mensaje de respuesta.

Puede haber varias páginas de resultados disponibles, pero la página que se devuelve es la que se solicita mediante el parámetro page . Si desea la página siguiente, debe realizar otra solicitud e incrementar el número de página. Establezca el parámetro pageSize en el número de objetos que desea que se devuelvan en el mensaje de respuesta.

La sintaxis de consulta para el parámetro de búsqueda en cualquier solicitud GET que utilice la API de Caseware Cloud es la siguiente:

<nombre de campo><operador><valor de campo>

Si deja la consulta en blanco, se mostrarán todos los objetos de la lista.

<nombreCampo> es el nombre del campo de nivel superior sobre el que desea operar.

Nota: No todos los fieldNames son válidos. El campo debe ser un tipo de dato primitivo como texto, números, booleanos y fechas. Los tipos de datos complejos, como las colecciones o los objetos, no permiten búsquedas.

Consejo: La mayoría de los campos (o parámetros de consulta) que pueden utilizarse para formar consultas (especificados como el valor del parámetro de consulta de búsqueda) se describen en el esquema del cuerpo de la solicitud en la operación POST Create para el objeto que está consultando. Por ejemplo, si está consultando entidades, consulte la operación POST Crear para entidades:

Operadores relacionales admitidos

<operator> puede ser cualquiera de los siguientes:

• = (igual a)
• < (menor que)
• > (mayor que)
• <> (no igual a)

<campoValor> puede ser cualquier valor escalar, es decir, cualquier valor individual:

Para texto, es decir, cualquier campo cuyo tipo de datos sea String, debe especificar el valor entre comillas simples:

fieldName='prueba'

Para los campos cuyo tipo de datos contenga caracteres especiales como ' o \ debe utilizar un carácter de escape (\) en la consulta de búsqueda:

fieldName='randomText\'s randomText'

Para los campos cuyo tipo de datos es numérico, especifique el valor numérico sin comillas:

fieldName=123

Para los campos cuyo tipo de datos es booleano,especifica "true" o "false":

fieldName='true'

Para los campos cuyo tipo de dato es la fecha, la fecha debe seguir este formato ISO:

fieldName='AAAA-MM-DDTHH:MM:SS:Z'

Operadores lógicos admitidos

Para ayudar a filtrar los resultados, puede combinar dos o más sentencias de filtro con los operadores lógicos Y u O. El operador AND tiene prioridad sobre OR. Debe especificar un espacio antes y después del operador:

<nombre de campo><operador><valor de campo> AND <nombre de campo><operador><valor de campo>

Operador	Descripción	Ejemplo
AND	Une dos o más sentencias de filtro mediante el operador AND.	countryCode='CA' AND modifyDate>'2022-01-01'
.OR.	Une dos o más sentencias de filtro mediante el operador OR.	countryCode='US' OR countryCode='CA'