Documentation de service Web / Catégories / Services de signalement / Get Available Metrics List (obtenir la liste des mesures disponibles)

Get Available Metrics List (obtenir la liste des mesures disponibles)

Mise à jour le 26 février 2024

Description

Ce service Web renvoie la liste de toutes les mesures que vous pouvez intégrer à un gabarit de rapport.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/reports/metrics?groupIds=(groupIds)&availableToCustomMetrics=(availableToCustomMetrics)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
availableToCustomMetrics Facultatif.Si la valeur est réglée sur vrai, vous obtiendrez une liste de mesures qui peuvent être utilisées pour définir une mesure personnalisée (dans le numérateur). Si la valeur est réglée sur faux, vous obtiendrez une liste de mesures qui ne peuvent pas être utilisées pour définir une mesure personnalisée (dans le numérateur). S'il est omis, vous obtiendrez toutes les mesures.
groupIds facultatif. Liste délimitée par virgules des identificateurs uniques de groupe, que vous pouvez ensuite filtrer. Par défaut, tous les groupes.

Schémas XML

Demande/réponse Nom de schéma
Demande Aucun
Réponse reportMetrics.xsd

Exemples de demande

L’exemple ci-dessous récupère la liste des mesures qui sont regroupées en fonction de l’identifiant groupId allant de 1 à 13.

GET  /reports/metrics?groupIds=1,13

L’exemple ci-dessous permet de récupérer la liste de toutes les mesures.

GET  /reports/metrics

Exemple de réponse

L’exemple suivant montre les résultats lorsque vous utilisez ce service Web.

<?xml version="1.0" encoding="UTF-8"?>
<reportMetrics>
     <group id="1" name="Data Accuracy">
          <metrics>
               <metric id="6" name="estimatedDataFlagElectricityGridPurchase" description="Estimated Data Flag - Electricity (Grid Purchase)" dataType="string" availableToCustomMetrics="false"/>
               <metric id="7" name="estimatedDataFlagElectricityOnsiteSolar" description="Estimated Data Flag - Electricity (Onsite Solar)" dataType="string" availableToCustomMetrics="false"/>
               <metric id="9" name="estimatedDataFlagNaturalGas" description="Estimated Data Flag - Natural Gas" dataType="string" availableToCustomMetrics="false"/>
               <metric id="10" name="estimatedDataFlagFuelOilNo2" description="Estimated Data Flag - Fuel Oil (No. 2)" dataType="string" availableToCustomMetrics="false"/>
               <!-- assume more records -->
          </metrics>
     </group>
     <group id="2" name="Data Center Metrics">
          <metrics>
               <metric id="132" name="dataCenterSourcePUE" description="Data Center - PUE" dataType="numeric"/>
               <metric id="133" name="dataCenterITEquipmentInputSiteEnergy" description="Data Center - IT Equipment Input Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
               <metric id="134" name="dataCenterPDUInputSiteEnergy" description="Data Center - PDU Input Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
               <metric id="135" name="dataCenterPDUOutputSiteEnergy" description="Data Center - PDU Output Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
               <metric id="136" name="dataCenterUPSOutputSiteEnergy" description="Data Center - UPS Output Meter" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
               <metric id="137" name="dataCenterITSiteEnergy" description="Data Center - IT Site Energy" dataType="numeric" uom="kWh" availableToCustomMetrics="true"/>
               <metric id="138" name="dataCenterITSourceEnergy" description="Data Center - IT Source Energy" dataType="numeric" uom="kBtu" availableToCustomMetrics="true"/>
               <metric id="139" name="dataCenterPUEMedian" description="Data Center - National Median PUE" dataType="numeric" availableToCustomMetrics="true"/>
          </metrics>
     </group>
     <group id="3" name="Property Design">
          <metrics>
               <metric id="140" name="designScore" description="Design ENERGY STAR Score" dataType="numeric" availableToCustomMetrics="true"/>
               <metric id="141" name="designSiteTotal" description="Design Site Energy Use" dataType="numeric" uom="kBtu" availableToCustomMetrics="true"/>
               <!-- assume more records -->
          </metrics>
     </group>
     <!-- assume more records -->
</reportMetrics>
ENVIRONNEMENT D'ESSAI