Servicios de localización de contadores
En esta sección, se describen los servicios web de localización de contadores del compuesto del arnés de pruebas de Adapter Development Kit.
FindMeters
Este servicio web consulta el almacén de datos en busca de uno o varios contadores. La diferencia entre GetMeter y FindMeters es que GetMeter puede devolver como máximo un contador y este debe coincidir exactamente con el ID indicado. GetMeter emitirá un error si no se encuentra el ID. FindMeters puede devolver más de un contador (cuando se utiliza regex) y no emitirá ningún error si el ID no coincide con ninguno de los contadores del índice.
Entrada: FindMetersInput
Parte: payload
Elemento: FindMetersRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El ID de contador que se va a buscar. |
|
isRegex |
El ID indicado puede ser un valor regex cuando este parámetro sea verdadero. Sugerencia: para buscar todos los contadores en el sistema, utilice ".*" para el ID. |
Salida: FindMetersOutput
Parte: payload
Elemento: FindMetersResult
La búsqueda puede devolver cero o más objetos de contador.
Fallo: consulte UtilityFault. A diferencia de otros métodos, FindMeters no emite una excepción si no se encuentra el contador.
IsMeterDefined
Este servicio web consulta si un contador concreto está definido en el almacén de datos.
Entrada: IsMeterDefinedInput
Parte: payload
Elemento: IsMeterDefinedRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El ID de contador que se va a buscar. |
Salida: IsMeterDefinedOutput
Parte: payload
Elemento: IsMeterDefinedResult
Si el ID indicado forma o no parte del índice.
Fallo: consulte UtilityFault. Se emite cuando no se encuentra el ID de contador.
GetMeter
Este servicio web devuelve todos los atributos de un solo contador del almacén de datos en memoria. La diferencia entre GetMeter y FindMeters es que GetMeter puede devolver como máximo un contador y este debe coincidir exactamente con el ID indicado. GetMeter emitirá un error si no se encuentra el ID. FindMeters puede devolver más de un contador (cuando se utiliza regex) y no emitirá ningún error si el ID no coincide con ninguno de los contadores del índice.
Entrada: GetMeterInput
Parte: payload
Elemento: GetMeterRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El ID de contador que se va a buscar. |
Salida: GetMeterOutput
Parte: payload
Elemento: GetMeterResult
El objeto de contador solicitado por el ID.
Fallo: consulte UtilityFault. Se emite cuando no se encuentra el ID de contador.