header.banner.text
Documentation de service Web / Catégories / Services de signalement
Services de signalement
Les services de rapports vous permettent de récupérer les mesures pour vos propriétés et répondre aux demandes de données au nom de vos clients.Les services qui vous permettent de récupérer des mesures de production de rapports sont divisés en deux catégories. La première catégorie concerne un ensemble d’interfaces API qui vous permettent d’interagir avec la fonction de signalement personnalisé dans l’interface utilisateur de Portfolio Manager. Cet ensemble de services Web n’est disponible que dans l’environnement de production. Pour en savoir davantage, voir le guide de l’API pour la production de rapports individualisés . Ces API vous permettent également d’utiliser plus de 10 rapports ENERGY STAR prédéfinis par l’EPA. Pour en savoir davantage, voir le guide de l’API pour les rapports ENERGY STAR. Tous les calculs de mesures faits par ces API se comportent de manière asynchrone. La deuxième catégorie concerne l’ensemble original d’API qui vous permet de récupérer un ensemble plus restreint de calculs de mesures qui se comportent de manière synchrone.
Les services qui vous permettent de répondre aux requêtes de données au nom de vos clients sont semblables à la fonctionnalité fournie par l’interface utilisateur. Cet ensemble de services Web n’est disponible que dans l’environnement de production. Pour de plus amples renseignements, veuillez consulter le Guide d’interface API pour les réponses de données.
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 personnalisés (répondre aux demandes de données)
| Méthode | REST URI * | Description |
|---|---|---|
| GET | /reports/customers/(customerId)/dataRequests/(dataRequestId) | Renvoie les informations pour la demande de données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataRequests?status=(status) | Renvoie une liste de demandes de données pour un client spécifique. |
| POST | /reports/customers/(customerId)/dataResponses | Crée une réponse de données pour la demande de données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses/(dataResponseId) | Renvoie une liste de propriétés associées à la réponse de données d’un client spécifique. |
| PUT | /reports/customers/(customerId)/dataResponses/(dataResponseId) | Met à jour la liste des propriétés à la réponse de données d’un client spécifique. |
| DELETE | /reports/customers/(customerId)/dataResponses/(dataResponseId) | Supprime la réponse de données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses/(dataResponseId)/download?type=(type) | Télécharge les résultats de l’aperçu de la réponse des données pour un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses/(dataResponseId)/errors/download?type=(type) | Renvoie les informations d’erreur associées à l’aperçu des données de réponse d’un client spécifique. |
| POST | /reports/customers/(customerId)/dataResponses/(dataResponseId)/generate | Génère un aperçu de la réponse aux données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses/(dataResponseId)/receipt/download | Télécharge un reçu PDF de la réponse d’un client spécifique. |
| POST | /reports/customers/(customerId)/dataResponses/(dataResponseId)/send | Soumet et finalise la réponse aux données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses/(dataResponseId)/status | Renvoie les informations d’état de la réponse aux données d’un client spécifique. |
| DELETE | /reports/customers/(customerId)/dataResponses/dataRequests/(dataRequestId) | Supprime l’accès à la demande de données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses/dataRequests/(dataRequestId)/download?type=(type) | Télécharge toutes les réponses de données pour une demande de données d’un client spécifique. |
| GET | /reports/customers/(customerId)/dataResponses?status=(status)&dataRequestId=(dataRequestId) | Renvoie une liste de réponses de données pour la demande de données d’un client spécifique. |
Signalement
| 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 de production, par rapport à l'URI de base : https://portfoliomanager.energystar.gov/ws
