Índice

Search

  1. Prólogo
  2. Introducción a los servicios de entidad de negocio
  3. Llamadas del servicio de entidad de negocio de EJB
  4. Llamadas del servicio de entidad de negocio de REST
  5. API REST para Data Director
  6. Llamadas del servicio de entidad de negocio de SOAP
  7. Servicios de cálculos de BVT y registros de referencias cruzadas
  8. Compatibilidad del servicio de vinculación empresarial
  9. Llamadas externas para limpiar, analizar y transformar datos
  10. Apéndice A: Uso de las API de REST para añadir registros
  11. Apéndice B: Uso de las API de REST para cargar archivos
  12. Apéndice C: Uso de las API de REST para administrar informes

Guía de servicios de entidad de negocio

Guía de servicios de entidad de negocio

Parámetros de consulta

Parámetros de consulta

Utilice el parámetro
fuzzyFilter
para especificar los valores de campo que desea consultar. Utilice el parámetro
fuzzyFilter
con el parámetro
action
.
En la siguiente tabla se describen los parámetros de consulta que puede usar en la URL:
Parámetro
Descripción
action
Obligatorio. Devuelve los registros coincidentes para la entidad de negocio especificada. Establézcalo en
match
y use el parámetro con el parámetro
fuzzyFilter
.
Por ejemplo, utilice la siguiente consulta para buscar una persona con el nombre STEVE:
Person?action=match&fuzzyFilter=STEVE
fuzzyFilter
Obligatorio. Especifica una lista de pares de nombre de campo y valor de campo separados por comas que quiere usar para consultar los registros de un tipo de entidad de negocio específico.
Por ejemplo, utilice la siguiente consulta para buscar registros que tengan el nombre STEVE y una dirección de Toronto:
Person?action=match&fuzzyFilter=firstName=STEVE,Address.Address.City=TORONTO
matchRuleSet
Especifica un conjunto de reglas de coincidencia en función del cual desea identificar los registros coincidentes.
Si no tiene un conjunto de reglas de coincidencia específico, especifique NONE. Se utilizan las reglas de coincidencia de fusión automática y manual.
filter
Especifica los valores de campo que se van a usar para filtrar los resultados de una búsqueda parcial.
Por ejemplo, utilice la siguiente consulta para buscar los registros que tengan el nombre STEVE y que vivan en Toronto:
Person?action=match&fuzzyFilter=firstName='STEVE',lastName="SMITH'&filter=city=Toronto
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=match&fuzzyFilter=firstName='STEVE'&filter=city=Toronto
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=match&fuzzyFilter=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.
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" }
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=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city=Toronto AND gender=Male
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 el apellido JOHN, y que vivan en la ciudad de Toronto u Ottawa:
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city in [Toronto,Ottawa]
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=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=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=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]