Í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

El ID del registro es un parámetro obligatorio. La API usa el ID de registro para buscar todos los eventos de historial relacionados.
En la tabla siguiente se muestran los parámetros de la consulta:
Parámetro
Descripción
startDate y
endDate
Opcional. Intervalo de fechas para el que desea recuperar los datos. Si especifica un intervalo de fechas, la respuesta contiene solo eventos de este intervalo.
granularity
Opcional. Nivel de detalle para agrupar eventos de historial. Si se especifica, la respuesta agrupa los eventos de historial. En caso contrario, la respuesta no agrupa los eventos de historial.
Use uno de los siguientes valores:
  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • AUTO
recordStates
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
contentMetadata
Opcional. Metadatos para la lista de eventos del historial. Proporcione una lista de valores separados por comas.
Puede usar los siguientes valores:
  • XREF
  • PENDING_XREF
  • DELETED_XREF
  • HISTORY
  • MATCH
  • BVT
  • TRUST
children
Opcional. Lista separada por comas de los nombres de nodos secundarios. Si se especifica, la respuesta contiene los nombres de los nodos secundarios.
order
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.
fields
Opcional. Lista de campos de entidad de negocio separados por comas. Si se especifica, la respuesta solo contiene los campos indicados.
filter
Opcional. Expresión de filtro.
depth
Opcional. El número de niveles secundarios que se devolverán.
recordsToReturn
Opcional. Especifica el número de filas que se van a devolver.
searchToken
Opcional. Especifica el token de búsqueda que se devuelve con la solicitud anterior.
returnTotal
Opcional. Si se establece en
true
, devuelve el número de registros en el resultado. El valor predeterminado es
false
.
firstRecord
Opcional. Especifica la primera fila del resultado.
changeType
Opcional. Especifica los tipos de cambio devueltos en el resultado. Proporcione una lista de valores separados por comas.
Puede usar los siguientes valores:
  • BO
  • XREF
  • BVT
  • MERGE
  • MERGE_AS_SOURCE
  • MERGE_AS_TARGET
  • UNMERGE_AS_SOURCE
  • UNMERGE_AS_TARGET