Guía de servicios de entidad de negocio

10.3

Anterior Siguiente

Parámetros de consulta

Utilice los parámetros de consulta q o fq para proporcionar el valor de cadena para la búsqueda. Los parámetros de consulta q y fq se excluyen mutuamente. Utilice el parámetro fq para una búsqueda por campos. Utilice el operador lógico AND para varias condiciones.

La siguiente tabla muestra los parámetros que puede usar en la URL:

Parámetro	Descripción
q	Especifica el valor de cadena o el término de la búsqueda. La consulta busca ocurrencias del término de la búsqueda en cualquier parte de un registro. Se utiliza en una búsqueda simple. Por ejemplo, la consulta Person?q=STEVE busca registros que incluyan el término STEVE. Para buscar dos o más términos a la vez, incluya los términos entre comillas dobles. Anteponga el carácter + a cada término si desea que los resultados de búsqueda contengan este término. Si el valor de campo contiene un espacio, incluya el valor de campo entre comillas simples. Utilice la siguiente consulta para encontrar una coincidencia exacta con WILLIAM JOHN LAWSON: Person?q="WILLIAM JOHN LAWSON" Utilice la siguiente consulta para encontrar WILLIAM, JOHN o LAWSON: Person?q=WILLIAM JOHN LAWSON Utilice la siguiente consulta para encontrar WILLIAM, JOHN y LAWSON: Person?q=WILLIAM JOHN LAWSON&queryOperator=AND
fq	Especifica el valor de cadena o el término de búsqueda en un campo determinado. La consulta busca el término solo en esa parte de un registro. Se utiliza en una búsqueda dirigida en campos indexados. Por ejemplo, la consulta Person?fq=displayname=STEVE busca registros que incluyan el nombre para mostrar STEVE.
facetas	Especifica los campos que se deberían tratar como facetas o categorías a partir de los cuales se agrupan los resultados de la búsqueda. Especifique solo campos que admitan búsquedas. Se utiliza con los parámetros q y fq. La sintaxis es &facets=FieldName1,FieldName2,FieldNameN Por ejemplo, la consulta Person?q=STEVE&facets=department busca personas que incluyan el nombre para mostrar STEVE y agrupa los resultados de la búsqueda por departamentos. La búsqueda muestra los registros de las personas con el nombre para mostrar STEVE y estos registros se agrupan por departamentos.
filtros	Especifica los campos mediante los que puede acotar los resultados de la búsqueda. Especifique solo campos que admitan filtros. Se utiliza con los parámetros q y fq. Por ejemplo, la consulta Person?fq=STEVE&filters=birthdate='1980-11-27T08:00:00Z' busca personas que incluyan el nombre para mostrar STEVE y filtra los resultados de la búsqueda por fecha de nacimiento. La búsqueda muestra los registros de las personas con el nombre para mostrar STEVE y cuya fecha de nacimiento sea el 27 de noviembre de 1980. Especifique una fecha entre comillas simples.
depth	Especifica el número de niveles secundarios que se van a devolver. Especifique 2 para devolver el nodo raíz y sus elementos secundarios directos, y 3 para devolver el nodo raíz, el elemento secundario directo y los elementos secundarios de segundo nivel. Especifique 1 para devolver el nodo raíz únicamente. De manera predeterminada, no se especifica ninguna profundidad. Si no se especifica ninguna profundidad, los resultados de búsqueda devuelven el nodo raíz y los elementos secundarios en los que se ha encontrado una coincidencia para el término de búsqueda. Por ejemplo, la consulta Person?q=STEVE&depth=2 busca los resultados que incluyan el término STEVE y devuelve la información sobre el registro raíz y sus elementos secundarios directos.
queryOperator	Especifica si la búsqueda encuentra algunas de las cadenas del término de búsqueda o todas las cadenas del término de búsqueda. El parámetro toma uno de los siguientes valores: OR . Busca alguna de las cadenas que aparecen en el parámetro f o fq . AND . Busca todas las cadenas que aparecen en el parámetro f o fq . Si no especifica este parámetro, el valor predeterminado es OR . Por ejemplo, la consulta Person?q=WILLIAM JOHN LAWSON&queryOperator=AND busca los registros que contengan WILLIAM, JOHN y LAWSON.
suppressLinks	Indica si los vínculos entre elementos primarios y secundarios se pueden ver en la respuesta de la API. Establezca el parámetro en true para suprimir todos los vínculos entre elementos primarios y secundarios en la respuesta. El valor predeterminado es false. Por ejemplo, la consulta Person?q=STEVE&suppressLinks=true busca registros con el término STEVE y devuelve una respuesta en la que no se incluyen vínculos entre elementos primarios y secundarios.
readSystemFields	Indica si desea devolver los campos del sistema en el resultado. El valor predeterminado es false.
order	Lista de nombres de campo separados por comas con el prefijo opcional + o - . El prefijo + indica la ordenación ascendente de los resultados y el prefijo - indica la ordenación descendente de los resultados. El valor predeterminado es + . Si desea usar un campo secundario para ordenar los resultados, use el nombre completo del campo. Por ejemplo, BillAddresses.Address.cityName . Si especifica más de un parámetro, el conjunto de resultados se ordena por el primer parámetro de la lista, seguido del segundo. Por ejemplo, la consulta Person?order=displayName,-BillAddresses.Address.cityName ordena los resultados por el nombre para mostrar en orden ascendente y, a continuación, por el nombre de ciudad en orden descendente.
maxRecordsToSort	Número máximo de resultados de búsqueda que desea ordenar. El valor predeterminado es 1000.

Especifique un rango con el parámetro
filters
:

Puede usar el parámetro filters para acotar las resultados de la búsqueda dentro de un rango determinado. Puede especificar el rango para los campos que admiten filtros de tipos de datos numéricos y de fecha.

Utilice el siguiente formato para el tipo de datos de enteros:

fieldName1=[fromValue,toValue]

El rango oscila de fromValue a toValue. Asegúrese de que fromValue sea inferior a toValue. Por ejemplo, la consulta

filters=age=[35,45]

acota los resultados de la búsqueda y busca registros en el grupo de edades comprendido entre 35 y 45.

Utilice el siguiente formato para el tipo de datos de fecha:

fieldName1=[fromDate,toDate]

El rango oscila de fromDate a toDate. Por ejemplo, la consulta

filters=birthdate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

especifica la fecha de nacimiento entre el 12 de junio de 2000 y el 12 de junio de 2015.

Cuando especifique un filtro de datos de coincidencia exacta, inclúyalo entre comillas simples. Cuando especifique un rango de fechas, no utilice las comillas.

Búsqueda Registro

Formatos de fecha y hora UTC

Descargar guía

Enviar comentarios

Communities

Knowledge Base

Success Portal

Rename Saved Search

Índice

Guía de servicios de entidad de negocio

Guía de servicios de entidad de negocio

Parámetros de consulta

Parámetros de consulta