Documentation de service Web / Catégories / Services des propriétés / Obtenir la liste des mesures disponibles

Obtenir la liste des mesures disponibles

Mise à jour le 26 février 2024

Description

Ce service Web renvoie une liste de toutes les mesures disponibles qui peuvent être utilisées pour définir une mesure personnalisée (le numérateur d'une mesure personnalisée).

Version

22.0

Méthode HTTP

GET

URL de la ressource

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

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
availableToCustomMetrics Réglez la valeur sur vrai pour obtenir une liste de mesures qui peuvent être utilisées pour définir une mesure personnalisée (dans le numérateur).
groupIds Facultatif. Liste délimitée par des virgules d'identifiants uniques de groupes à filtrer. La valeur par défaut est « tous les groupes ».

Schémas XML

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

Exemple de demande

L'exemple ci-dessous extrait la liste des mesures qui se trouvent dans des groupes dont l'identifiant (groupId) est 2 et 3.

GET  /reports/metrics?groupIds=2,3&availableToCustomMetrics=true

Exemple de réponse

L'exemple suivant présente la liste des mesures à utiliser pour définir une mesure personnalisée pour les groupes indiqués.

<?xml version="1.0" encoding="UTF-8"?>
<reportMetrics>
     <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