Buscar
La Búsqueda API le permite buscar una configuración actual o programada utilizando campos de búsqueda comunes y/o específicos de la configuración.
Resultados de búsqueda
Todos los puntos finales de búsqueda por ID devuelven conjuntos de resultados completos sin paginación. Esto significa que todos los ajustes coincidentes se devolverán en una única respuesta, sin necesidad de navegación por páginas.
Buscar Configuración Actual
Los siguientes puntos finales permiten buscar una configuración actual:
GET/settings-objects/{settingType}
GET/settings-objects/{settingType}/getIds
El activeFrom el parámetro filtra los resultados para incluir únicamente configuraciones que estén activas en la fecha y hora especificadas. Para devolver una configuración actual, el activeFrom el valor debe estar en o después del activeFromDate del ajuste actual, pero antes de la activeFromDate de una configuración programada (si existe).
-
Si
activeFromse establece en una fecha-hora posterior a la activación de una configuración programada, se devuelve la configuración programada. -
Si
activeFromse establece a una fecha-hora posterior alactiveFromDatede una configuración actual pero antes delactiveFromDatede una configuración programada, se devuelve la configuración actual. -
Si
activeFromse establece a una fecha-hora anterior alactiveFromDatede una configuración actual, no se devuelven resultados.
El opcional processingEntity El parámetro, si se proporciona en la solicitud, asegura que solo la Entidad de Procesamiento propietaria de la configuración pueda recuperar sus propias configuraciones.
|
Buscar Configuraciones Programadas
Los dos puntos finales a continuación permiten buscar una configuración programada, pero el 'activeFrom' el valor debe estar en o después del activeFromDate de la configuración programada.
GET/settings-objects/{settingType}
GET/settings-objects/{settingType}/getIds
Es mucho más fácil buscar una configuración programada a través de un punto final alternativo dedicado únicamente a las configuraciones de programación:
GET/settings-objects/scheduled-settings/{settingType}
Este endpoint no soporta el activeFrom el parámetro es compatible, por lo tanto, se devuelven todas las configuraciones programadas que coinciden con los criterios de búsqueda.
Configuración de Campos Específicos Buscables
Cada configuración puede definir un subconjunto de sus campos que puede ser utilizado como campos buscables.
Para ver cómo definir campos de búsqueda específicos de configuración, vaya a Campos buscables