Documentation de service Web / Catégories / Services de rapports

Services de rapports

Les services de rapports vous permettent de récupérer des mesures pour vos propriétés. Ces services sont divisés en deux catégories. La première catégorie comprend un ensemble d’API qui vous permettent d’interagir avec la fonction de rapports personnalisés dans l’interface utilisateur de Portfolio Manager. Pour plus de renseignements, veuillez consulter le Guide de l’API des rapports personnalisés. Ces API vous permettent également d’interagir avec plus de 10 rapports ENERGY STAR prédéfinis par l’EPA. Pour plus de renseignements, veuillez consulter le Guide de l’API des rapports ENERGY STAR. Tous les calculs de mesures lancés par ces API sont effectués de manière asynchrone. La deuxième catégorie comprend l’ensemble original d’API qui vous permettent de récupérer un ensemble plus restreint de calculs de mesures effectués de manière synchrone.

Rapports personnalisés (gestion des gabarits)

Méthode REST URI * Description
GET /reports/metrics?groupIds=(groupIds)&availableToCustomMetrics=(availableToCustomMetrics) Renvoie une liste de mesures accessibles qui peuvent être utilisées dans un modèle de rapport.
POST /reports/templates Crée un modèle de rapport dans votre compte. Renvoie des identifiants uniques pour le modèle et le rapport correspondant.
GET /reports/templates/(templateId) Met à jour les renseignements pour un modèle de rapport particulier. Vous devez être responsable du modèle de rapport.
PUT /reports/templates/(templateId) Met à jour les renseignements pour un modèle de rapport particulier. Vous devez être responsable du modèle de rapport.
DELETE /reports/templates/(templateId) Supprime un gabarit de rapport précisé. Vous devez être responsable du modèle de rapport.
GET /reports/templates?type=(type) Renvoie une liste des modèles de rapport dans votre compte.

Rapports personnalisés (gestion des rapports)

Méthode REST URI * Description
GET /reports/(reportId) Renvoie les renseignements pour un modèle de rapport particulier. Vous devez être responsable du modèle de rapport.
PUT /reports/(reportId) Met à jour les renseignements pour un rapport particulier. Vous devez être responsable du rapport.
GET /reports/(reportId)/download?type=(type) Télécharge les résultats pour un rapport particulier. Vous devez être chargé du rapport.
POST /reports/(reportId)/generate Produit un rapport particulier. Vous devez être chargé du rapport.
GET /reports/(reportId)/status Renvoie les renseignements sur l’état pour un rapport particulier. Vous devez être chargé du rapport.
GET /reports?type=(type) Renvoie une liste de rapports dans votre compte.

Rapports

Méthode REST URI * Description
GET /property/(propertyId)/design/metrics Retourne une liste des valeurs des mesures pour une conception de propriété existante. La propriété doit déjà être partagée avec vous.
GET /property/(propertyId)/metrics Retourne les valeurs associées à un ensemble spécifié de mesures et d’unités pour une propriété et une date de fin de période spécifiques. La propriété doit déjà être partagée avec vous.
GET /property/(propertyId)/metrics/monthly Affiche une liste des valeurs de mesures mensuelles pour une propriété et une date de fin de période précise en fonction de l’ensemble de mesures et du système de mesure précisés.
GET /property/(propertyId)/reasonsForNoScore Récupère une liste d'informations sur les alertes qui expliquent les raisons pour lesquelles une propriété ne peut recevoir une cote ENERGY STAR pour une période donnée.
GET /property/(propertyId)/reasonsForNoWaterScore Récupère une liste d'informations sur les alertes qui expliquent les raisons pour lesquelles une propriété ne peut recevoir une cote d'eau ENERGY STAR pour une période donnée.
GET /property/(propertyId)/useDetails/metrics Retourne les valeurs des détails d’utilisation pondérées dans le temps pour une propriété, une date de fin de période et un système de mesures spécifiques. La propriété doit déjà être partagée avec vous.

* Pour l’environnement d’essai, par rapport à l’URI de base :  https://portfoliomanager.energystar.gov/wstest

** Les services Web sont uniquement disponibles dans l’environnement d’essai.

ENVIRONNEMENT D'ESSAI