Buscar
La Búsqueda API le permite buscar un actual o scheduled configuración 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 valor activeFrom debe ser en o después del activeFromDate del ajuste actual, pero antes de la activeFromDate de un scheduled ajuste (si existe).
-
Si
activeFromse establece en una fecha-hora posterior a la activación de un scheduled ajuste, el scheduled se devuelve la configuración. -
Si
activeFromestá configurado a una fecha-hora posterior alactiveFromDatede una configuración actual pero antes de laactiveFromDatede un scheduled la configuración actual se devuelve. -
Si
activeFromestá configurado 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 Scheduled Configuraciones
Los dos puntos finales a continuación permiten buscar un scheduled configuración, pero el valor 'activeFrom' debe estar en o después del activeFromDate de la scheduled configuración.
GET/settings-objects/{settingType}
GET/settings-objects/{settingType}/getIds
Es mucho más fácil buscar un scheduled configuración a través de un punto final alternativo dedicado únicamente a la configuración de horarios:
GET/settings-objects/scheduled-settings/{settingType}
Este endpoint no admite el parámetro activeFrom, por lo tanto, todos scheduled se devuelven las configuraciones 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 utilizarse como campos de búsqueda.
Para ver cómo definir campos de búsqueda específicos de configuración, vaya a Campos buscables