announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Web Service Documentation / Categories / Property Services / Get Custom Metric

Get Custom Metric

Updated on February 26, 2024

Description

This web service returns information for a specific custom metric for a given property. The property must already be shared with you.

Version

25.0

HTTP Method

GET

Resource URL

/property/(propertyId)/customMetrics/(customMetricSlot)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customMetricSlot Slot or position number (as displayed in the user interface) that identifies the custom metric.
propertyId Id to the property that is to be updated

XML Schemas

Request/Response Schema Name
Request None
Response customMetrics.xsd

Example Request

The following example retrieves the information for the custom metric (that displays first in the user interface) that belongs to a property that has an id of 14.

GET  /property/14/customMetrics/1

Example Response

The following example displays the informaton for the custom metric.

<?xml version="1.0" encoding="UTF-8"?>
<customMetric>
     <name>Site Energy Use per Computer</name>
     <numeratorMetricId>272</numeratorMetricId>
     <denominatorDetailTypeId>2</denominatorDetailTypeId>
</customMetric>
LIVE