Búsqueda
El API de búsqueda permite buscar una configuración actual o programada usando campos buscables comunes y/o específicos de la configuración.
Resultados de búsqueda
Todos los endpoints de búsqueda por IDs devuelven conjuntos de resultados completos sin paginación. Esto significa que todas las configuraciones coincidentes se devolverán en una única respuesta, sin necesidad de navegación por páginas.
Buscar configuración actual
Los siguientes endpoints permiten buscar una configuración actual:
GET/settings-objects/{settingType}
GET/settings-objects/{settingType}/getIds
El parámetro activeFrom filtra resultados para incluir solo configuraciones que estén activas en la fecha y hora especificadas. Para devolver una configuración actual, el valor de activeFrom debe ser igual o posterior al activeFromDate de la configuración actual, pero anterior al activeFromDate de una configuración programada (si existe).
-
Si
activeFromse establece en una fecha y hora posterior a la activación de una configuración programada, se devuelve la configuración programada. -
Si
activeFromse establece en una fecha y hora posterior alactiveFromDatede una configuración actual pero anterior alactiveFromDatede una configuración programada, se devuelve la configuración actual. -
Si
activeFromse establece en una fecha y hora anterior alactiveFromDatede una configuración actual, no se devuelven resultados.
Buscar configuraciones programadas
Los dos endpoints siguientes permiten buscar una configuración programada, pero el valor de 'activeFrom' debe ser igual o posterior al 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 endpoint alternativo dedicado solo a configuraciones programadas:
GET/settings-objects/scheduled-settings/{settingType}
Este endpoint no admite el parámetro activeFrom, por lo tanto se devuelven todas las configuraciones programadas que coinciden con los criterios de búsqueda.
Campos buscables específicos de la configuración
Cada configuración puede definir un subconjunto de sus campos que pueden usarse como campos buscables.
Para ver cómo definir campos buscables específicos de la configuración vaya a Searchable Fields