メーター検索サービス
この項では、テスト・ハーネス・コンポジットのメーター検索Webサービスについて説明します。
FindMeters
このWebサービスは、データ・ストアに1つ以上のメーターを問い合せます。GetMeterとFindMetersの違いは、GetMeterが最大で1つのメーターを返すことができ、それが指定されたIDと完全に一致する必要があるという点です。IDが見つからない場合、GetMeterはエラーをスローします。FindMetersは複数のメーターを返すことができ(regexの使用時)、IDが索引内のメーターのいずれにも一致しない場合でもエラーをスローしません。
入力 - FindMetersInput
部分: ペイロード
要素: FindMetersRequest
パラメータ |
摘要 |
---|---|
id |
検索するメーターID |
isRegex |
このパラメータがtrueの場合、IDをregex値で指定できます。ヒント: システム内のすべてのメーターを検索するには、IDに".*"を使用します。 |
出力 - FindMetersOutput
部分: ペイロード
要素: FindMetersResult
ゼロ個以上のメーター・オブジェクトが検索から返される場合があります
障害 — 「UtilityFault」を参照してください。他のメソッドとは異なり、FindMetersはメーターが見つからない場合でも例外をスローしません。したがって、メーターの存在を問い合せる前にテストするために使用できます。
IsMeterDefined
このWebサービスは、特定のメーターがデータ・ストアに定義されているかどうかを問い合せます。
入力 - IsMeterDefinedInput
部分: ペイロード
要素: IsMeterDefinedRequest
パラメータ |
摘要 |
---|---|
id |
検索するメーターID |
出力 - IsMeterDefinedOutput
部分: ペイロード
要素: IsMeterDefinedResult
指定されたIDが索引の一部であるかどうか。
障害 — 「UtilityFault」を参照してください。メーターIDが見つからない場合にスローされます。
GetMeter
このWebサービスは、インメモリー・データ・ストアから1つのメーターのすべての属性を返します。GetMeterとFindMetersの違いは、GetMeterが最大で1つのメーターを返すことができ、それが指定されたIDと完全に一致する必要があるという点です。IDが見つからない場合、GetMeterはエラーをスローします。FindMetersは複数のメーターを返すことができ(regexの使用時)、IDが索引内のメーターのいずれにも一致しない場合でもエラーをスローしません。
入力 - GetMeterInput
部分: ペイロード
要素: GetMeterRequest
パラメータ |
摘要 |
---|---|
id |
検索するメーターID |
出力 - GetMeterOutput
部分: ペイロード
要素: GetMeterResult
IDで要求されたメーター・オブジェクト。
障害 — 「UtilityFault」を参照してください。メーターIDが見つからない場合にスローされます。