Localizar Serviços do Medidor
Esta seção descreve os serviços da Web de localização de medidor do composto do equipamento de teste.
FindMeters
Esse serviço da Web consulta o armazenamento de dados por um ou mais medidores. A diferença entre GetMeter e FindMeters é que GetMeter pode retornar no máximo um medidor e deve corresponder, exatamente, ao ID fornecido. GetMeter lançará um erro, se o ID não for encontrado. FindMeters pode retornar mais de um medidor (ao usar o regex) e não lançará um erro quando o ID não corresponder a nenhum dos medidores no índice.
Entrada — FindMetersInput
Parte: carga útil
Elemento: FindMetersRequest
Parâmetro |
Descrição |
---|---|
id |
O ID do medidor pelo qual pesquisar |
isRegex |
O ID fornecido pode ser um valor de regex quando esse parâmetro for verdadeiro. Dica: para procurar todos os medidores no sistema, use ".*" como o ID. |
Saída — FindMetersOutput
Parte: carga útil
Elemento: FindMetersResult
Zero ou mais objetos de medidor podem ser retornados da pesquisa
Falha — Consulte UtilityFault. Diferente de outros métodos, o FindMeters não lança uma exceção, se o medidor não for encontrado. Assim, pode ser usado para testar a existência de um Medidor, antes de fazer a consulta por ele.
IsMeterDefined
Esse serviço da Web consulta se um medidor específico é definido no armazenamento de dados.
Entrada — IsMeterDefinedInput
Parte: carga útil
Elemento: IsMeterDefinedRequest
Parâmetro |
Descrição |
---|---|
id |
O ID do medidor pelo qual pesquisar |
Saída — IsMeterDefinedOutput
Parte: carga útil
Elemento: IsMeterDefinedResult
Se ou não o ID fornecido faz parte do índice.
Falha — Consulte UtilityFault. Lançado quando o ID do medidor não é encontrado.
GetMeter
Esse serviço da Web retorna todos os atributos de um único medidor do armazenamento de dados na memória. A diferença entre GetMeter e FindMeters é que GetMeter pode retornar no máximo um medidor e deve corresponder, exatamente, ao ID fornecido. GetMeter lançará um erro, se o ID não for encontrado. FindMeters pode retornar mais de um medidor (ao usar o regex) e não lançará um erro quando o ID não corresponder a nenhum dos medidores no índice.
Entrada — GetMeterInput
Parte: carga útil
Elemento: GetMeterRequest
Parâmetro |
Descrição |
---|---|
id |
O ID do medidor pelo qual pesquisar |
Saída — GetMeterOutput
Parte: carga útil
Elemento: GetMeterResult
O objeto do medidor solicitado pelo ID.
Falha — Consulte UtilityFault. Lançado quando o ID do medidor não é encontrado.