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

Puede anexar los parámetros de consulta a la URL de solicitud para filtrar los detalles del registro.

En la tabla siguiente se muestran los parámetros de la consulta:

Parámetro	Descripción
depth	El número de niveles secundarios que se devolverán. 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. El valor predeterminado es 1.
effectiveDate	La fecha cuyos datos desea recuperar.
readSystemFields	Indica si desea devolver los campos del sistema en el resultado. El valor predeterminado es false.
recordStates	El estado del registro. Proporcione una lista de estados separados por comas. Los estados de registro admitidos son ACTIVE, PENDING y DELETED. El valor predeterminado es ACTIVE.
contentMetadata	Los metadatos del registro. Proporcione una lista de valores separados por comas. Por ejemplo, XREF, PENDING_XREF, DELETED_XREF, HISTORY, XREF_HISTORY y MATCH. Si selecciona MATCH, la respuesta contiene una lista de registros coincidentes recuperados de la tabla _MTCH.
historyDate	Fecha cuyos datos del historial desea recuperar. La respuesta contiene datos del registro para la fecha especificada que se han recuperado de la tabla _HIST. Puede usar historyDate con el parámetro contentMetadata para recuperar metadatos históricos. Establezca contentMetadata en XREF, BVT o TRUST. XREF. La respuesta contiene datos de referencias cruzadas históricos de la tabla _HXRF. BVT. La respuesta contiene la mejor versión de confianza histórica de la tabla _HCTL. TRUST. La respuesta contiene valores de configuración de confianza históricos de las tablas _HCTL y _HVXR.
children	Lista de los nombres de nodos secundarios o rutas separados por comas.
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/1242?depth=10&suppressLinks=true mostrará los detalles del registro de hasta 10 niveles secundarios, sin incluir vínculos entre elementos primarios y secundarios en la respuesta.
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 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/1242/Names?order=-name muestra el resultado con los nombres en orden descendente. La consulta Person/1242/BillAddresses?order=rowidObject,-effStartDate mostrará las direcciones de facturación con los valores de RowId en orden ascendente y la fecha de inicio efectiva en orden descendente.
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" }

En el siguiente ejemplo se muestra cómo se deben filtrar los detalles de un registro:

GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF

Leer registros

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