Í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

Parámetros

Especifique el sistema de origen que quiere devolver en la respuesta.
En la tabla siguiente se describen los parámetros del cuerpo de la solicitud:
Parámetro
Tipo
Descripción
orsId
Ruta de acceso
ID de almacén de datos de referencia operativa de la base de datos desde la cual recuperar el sistema de origen.
entityId
Ruta de acceso
ID de la entidad de negocio.
entityName
Ruta de acceso
Nombre de la entidad de negocio.
action
Consulta
La acción que quiere que realice la API. El siguiente es el valor predeterminado:
getSourceSystems
aggregate
Consulta
Opcional. Datos agregados entre varios XREF. Use los siguientes valores:
  • RECORD
  • NODE
  • ENTITY
children
Consulta
Opcional. Lista de nombres de nodo secundario. Si se especifica, la respuesta contiene los nombres de los nodos secundarios.
compact
Consulta
Opcional. Especifique para devolver un resultado compacto.
contentMetadata
Consulta
Opcional. Metadatos de la lista de eventos del historial. Use los siguientes valores:
XREF
PENDING_XREF
DELETED_XREF
HISTORY
MATCH
BVT
TRUST
contributorsOnly
Consulta
Opcional. Cuenta todos los XREF o aquellos que contribuyen con la mejor versión de confianza (BVT).
depth
Consulta
Opcional. El número de niveles secundarios que se devolverán.
describe
Consulta
Opcional. Agrega la descripción del sistema de origen.
fields
Consulta
Opcional. Lista de campos de entidad de negocio separados por comas. Si se especifica, la respuesta solo contiene los campos indicados.
filter
Consulta
Opcional. Expresión de filtro.
firstRecord
Consulta
Opcional. Especifica la primera fila del resultado.
order
Consulta
Opcional.
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 especifica más de un parámetro, el conjunto de resultados se ordena por el primer parámetro de la lista, seguido del segundo.
recordStates
Consulta
Opcional. Estados de registro devueltos en la lista de eventos del historial. Proporcione una lista de valores separados por comas.
Puede usar los siguientes valores:
  • ACTIVE
  • PENDING
  • DELETED
recordstoReturn
Consulta
Opcional. Especifica el número de filas que se van a devolver.
recordsTotal
Consulta
Opcional. Si se establece en
true
, devuelve el número de registros en el resultado. El valor predeterminado es
false
.