Guía de servicios de entidad de negocio

10.4 HotFix 3
- 10.4 HotFix 2
- 10.4
- 10.3 HotFix 1
- 10.3
- 10.2 HotFix 1
- 10.2

Anterior Siguiente

Parámetros de consulta

Defina la consulta como una lista de pares de campo y valor.

En la siguiente tabla se describen los parámetros de consulta que puede usar en la URL:

Parámetro	Descripción
action	Obligatorio. Devuelve todos los registros del tipo de entidad de negocio especificado en los resultados de la consulta. Establézcalo en query y use el parámetro con el parámetro filter . Cuando se utiliza sin el parámetro filter , la consulta busca todos los registros del tipo de entidad de negocio especificado. Por ejemplo, utilice la siguiente consulta para buscar todos los registros de entidad de negocio de persona: Person?action=query
filter	Obligatorio. Especifica una lista de pares de campo y valor separados por operadores. Los operadores válidos son AND, IN y Range. Por ejemplo, utilice la siguiente consulta para buscar los registros de persona que tengan el nombre STEVE y el apellido SMITH: Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
depth	Especifica el número de niveles de registros secundarios que se van a devolver. Por ejemplo, puede especificar los siguientes niveles: 1. Devuelve el registro raíz. 2. Devuelve el registro raíz y sus registros secundarios directos. 3. Devuelve el registro raíz, los registros secundarios directos y los registros de elementos secundarios de segundo nivel. Por ejemplo, utilice la siguiente consulta para buscar los registros que tengan el nombre STEVE y devolver información sobre el registro raíz y sus registros secundarios directos: Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'&depth=2
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, utilice la siguiente consulta para buscar los registros que tengan el nombre STEVE y devolver una respuesta en la que no se vean los vínculos entre elementos principales y secundarios: Person?action=query&filter=firstName='STEVE'&suppressLinks=true
readSystemFields	Indica si desea devolver los campos del sistema en el resultado. El valor predeterminado es false.
fields	Especifica los campos que se van a mostrar en los resultados de la consulta.
outputView	Especifica la vista de entidad de negocio que quiere utilizar para mostrar los resultados de la consulta. Cuando configure la vista de entidad de negocio para los resultados de la consulta, incluya los campos que quiere que aparezcan en los resultados de la consulta.
Order	Especifica el orden de los resultados de la consulta. Utilice el carácter más (+) como prefijo para especificar el orden ascendente y el carácter menos (-) como prefijo para especificar el orden descendente. De forma predeterminada, el resultado de la consulta se mostrará en orden ascendente. 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.
resolveLookup	Recupera todo el campo de búsqueda de una entidad de negocio específica. Establezca el parámetro en true para cargar el campo de búsqueda e incluirlo en la respuesta. El valor predeterminado es false. Por ejemplo, el campo addressType es un campo de búsqueda en el nivel secundario de la entidad de negocio de persona. Cuando el parámetro resolveLookup se establece en false, es posible que reciba la siguiente respuesta de la API REST: { "label": "LU Address Type", "addressType": "BILL" } Cuando el parámetro resolveLookups se establece en true, la respuesta de la API REST incluye detalles adicionales y es posible que reciba la siguiente respuesta de la API REST: { "label": "LU Address Type", "addressType": "BILL", "addressTypeDisp": "BILLING" }

Operadores

Se pueden utilizar los siguientes parámetros dentro del parámetro de filtro:

AND: Busca los registros que tienen todos los valores de campo enumerados en el parámetro de filtro.; Por ejemplo, utilice la siguiente consulta para buscar los registros que tengan el nombre STEVE y el apellido SMITH:
Person?action=query&filter=firstName='STEVE' AND lastName='SMITH'
IN: Busca los registros que tienen alguno de los valores enumerados en el parámetro de filtro.; Por ejemplo, utilice la siguiente consulta para buscar los registros que tengan el nombre STEVE o JOHN:
Person?action=query&filter=firstName IN [STEVE,JOHN]
Range: Busca los registros dentro de un intervalo especificado. Puede especificar un intervalo para los campos de tipo de datos de fecha y numéricos.; Utilice el siguiente formato para el tipo de datos de enteros:

<business entity field name>=[fromValue,toValue]

El rango oscila de fromValue a toValue. Asegúrese de que fromValue sea inferior a toValue.; Por ejemplo, utilice la siguiente consulta para buscar registros que estén en el grupo de edad de 35 a 45:
Person?action=query&filter=firstName IN [STEVE,JOHN] AND age=[35,45]; Utilice el siguiente formato para el tipo de datos de fecha:
<business entity field name>=[fromDate,toDate]

El intervalo oscila de fromDate a toDate.; Por ejemplo, utilice la siguiente consulta para buscar registros cuya fecha de nacimiento esté entre el 12 de junio de 2000 y el 12 de junio de 2015:
Person?action=query&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]
!=: Busca registros que no coincidan con un rango o valor de campo especificado.; Por ejemplo, utilice la siguiente consulta para buscar los registros que tengan un nombre que no sea ADAM:
Person?action=query&filter=firstName!='ADAM'

Por ejemplo, utilice la siguiente consulta para buscar los registros que tengan un nombre que no sea ADAM y la fecha de nacimiento sea antes del 16 de noviembre de 2017 y después del 16 de noviembre de 2020.
Person?action=query&filter=firstName!='ADAM' AND birthdate!=[2017-11-16T00:00:00,2020-11-16T00:00:00]
Comodín: Puede utilizar un operador comodín de asterisco (*) y texto para especificar un patrón de texto en lugar de una cadena de búsqueda completa. El operador comodín de asterisco se usa para aumentar las opciones de encontrar los registros que desea. El operador comodín de asterisco es útil cuando no sabe cuál es el texto exacto o quiere buscar un texto similar.; En la siguiente tabla se muestran cadenas de búsqueda de ejemplo y se explica cómo funcionan:; Cadena de consulta de ejemplo
Comportamiento de la consulta

John*
Consultas para registros que contienen un valor que empieza por
John
. Por ejemplo,
Johnson
o
Johnny
.

Jo*n
Consultas para registros que empiezan por
Jo
y terminan en
n
. Por ejemplo,
Johansson
o
Jordan
.

*
Devuelve todos los registros.

Cadena de consulta de ejemplo	Comportamiento de la consulta
John*	Consultas para registros que contienen un valor que empieza por John . Por ejemplo, Johnson o Johnny .
Jo*n	Consultas para registros que empiezan por Jo y terminan en n . Por ejemplo, Johansson o Jordan .
*	Devuelve todos los registros.

SearchQuery

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

Operadores