Skip to content
Internal API Catalog
/
Sustainability-Insight-Center
/
coefficients

Sustainability-Insight-Center (v1beta1)

The HPE Sustainability Insight Center API enables users to manage power consumption data that helps to reduce costs and achieve IT sustainability goals.

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE License

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/sustainability/public/openapi/sustainability-insight-ctr-latest/

https://us-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

usages

Aggregate usage data

Operations

coefficients

Create and retrieve custom coefficients for locations

Operations

Get all cost and co2 coefficients

Request

Get a list of all costs (amount per kWh) and co2 coefficients of all locations. Supports filtering by locationId.

Security
bearer
Query
offsetinteger(int32)>= 0

Zero-based resource offset to start the response from.

Default 0
Examples:
offset=10
limitinteger(int32)[ 0 .. 100 ]

Number of entities to return.

Default 10
Examples:
limit=10
filterstring

Limit the coefficients operated on by this endpoint, returning only the subset of entities that match the filter. The filter grammar is a subset of OData 4.0 supporting "eq" operator only. Coefficients can be filtered by:

  • locationId
Examples:
filter=locationId eq '00000000-0000-0000-0000-0000000000000'
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/sustainability/public/openapi/sustainability-insight-ctr-latest/sustainability-insight-ctr/v1beta1/coefficients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(coefficient)required
items[].​idstring(uuid)required

ID of the returned coefficient mapping

items[].​typestringrequired

Type of returned coefficient mapping

items[].​generationintegerrequired

Monotonically increasing update counter

items[].​createdAtstringrequired

The server-side creation time of this resource in ISO8601 format.

items[].​updatedAtstringrequired

The server-side last updated time of this resource in ISO8601 format.

items[].​associatedLocationobject

A reference to the Location resource that this coefficient is bound to.

items[].​startTimestring

The date in which this coefficient mapping takes effect for this location in ISO8601 format.

items[].​co2eGramsPerKwhnumber

The CO2 equivalent generation coefficient in grams per kilowatt-hour for this location. Null if default for this location.

items[].​costPerKwhnumber

The cost coefficient per kilowatt-hour for this location. Null if default for this location.

items[].​currencyobject(currencyComponent)

The currency code and currency name of the returned cost

items[].​costUsdPerKwhnumberDeprecated

The cost coefficient in USD per kilowatt-hour for this location. Null if default for this location.

countintegerrequired
totalintegerrequired
offsetintegerrequired
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 5,
  "total": 10,
  "offset": 5
}

Create cost and co2 coefficients for a location

Request

Create cost and co2 coefficients for a specific location's data. If a coefficient is provided, either the value must be provided of one of the use default or use current flags must be set. Takes effect after the returned start time.

Security
bearer
Bodyapplication/jsonrequired
locationIdstringrequired

The location URI.

co2eGramsPerKwhobject(coefficientInput)
costPerKwhobject(coefficientCostInput)
costUsdPerKwhobject(coefficientInput)Deprecated

Deprecated feature replaced by costPerKwh. Cannot be used in conjunction with costPerKwh and currency fields.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/sustainability/public/openapi/sustainability-insight-ctr-latest/sustainability-insight-ctr/v1beta1/coefficients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "locationId": "/locations/v1beta1/locations/00000000-0000-0000-0000-0000000000000"
  }'

Responses

OK

Headers
Locationstring

Resource URI of the created coefficient

Bodyapplication/json
idstring(uuid)required

ID of the returned coefficient mapping

typestringrequired

Type of returned coefficient mapping

generationintegerrequired

Monotonically increasing update counter

createdAtstringrequired

The server-side creation time of this resource in ISO8601 format.

updatedAtstringrequired

The server-side last updated time of this resource in ISO8601 format.

associatedLocationobject

A reference to the Location resource that this coefficient is bound to.

startTimestring

The date in which this coefficient mapping takes effect for this location in ISO8601 format.

co2eGramsPerKwhnumber

The CO2 equivalent generation coefficient in grams per kilowatt-hour for this location. Null if default for this location.

costPerKwhnumber

The cost coefficient per kilowatt-hour for this location. Null if default for this location.

currencyobject(currencyComponent)

The currency code and currency name of the returned cost

costUsdPerKwhnumberDeprecated

The cost coefficient in USD per kilowatt-hour for this location. Null if default for this location.

Response
application/json
{
  "id": "00000000-0000-0000-0000-0000000000000",
  "type": "sustainability-insight-ctr/coefficient",
  "associatedLocation": {
    "locationId": "00000000-0000-0000-0000-0000000000000",
    "locationName": "Location A",
    "resourceUri": "/locations/v1beta1/locations/00000000-0000-0000-0000-0000000000000"
  },
  "startTime": "2024-01-01T00:00:00.000Z",
  "co2eGramsPerKwh": 0.5,
  "costUsdPerKwh": 0.5,
  "costPerKwh": 0.5,
  "currency": {
    "currencyCode": "THB",
    "currencyName": "Chilean Peso"
  },
  "generation": 0,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

Get a single cost and co2 coefficient for an id

Request

Get a single cost and co2 coefficient for an id

Security
bearer
Path
idstring(uuid)required

UUID of the coefficient mapping

Examples:

ID for the coefficient mapping being accessed is "00000000-0000-0000-0000-0000000000000"

00000000-0000-0000-0000-0000000000000
curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/sustainability/public/openapi/sustainability-insight-ctr-latest/sustainability-insight-ctr/v1beta1/coefficients/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)required

ID of the returned coefficient mapping

typestringrequired

Type of returned coefficient mapping

generationintegerrequired

Monotonically increasing update counter

createdAtstringrequired

The server-side creation time of this resource in ISO8601 format.

updatedAtstringrequired

The server-side last updated time of this resource in ISO8601 format.

associatedLocationobject

A reference to the Location resource that this coefficient is bound to.

startTimestring

The date in which this coefficient mapping takes effect for this location in ISO8601 format.

co2eGramsPerKwhnumber

The CO2 equivalent generation coefficient in grams per kilowatt-hour for this location. Null if default for this location.

costPerKwhnumber

The cost coefficient per kilowatt-hour for this location. Null if default for this location.

currencyobject(currencyComponent)

The currency code and currency name of the returned cost

costUsdPerKwhnumberDeprecated

The cost coefficient in USD per kilowatt-hour for this location. Null if default for this location.

Response
application/json
{
  "id": "00000000-0000-0000-0000-0000000000000",
  "type": "sustainability-insight-ctr/coefficient",
  "associatedLocation": {
    "locationId": "00000000-0000-0000-0000-0000000000000",
    "locationName": "Location A",
    "resourceUri": "/locations/v1beta1/locations/00000000-0000-0000-0000-0000000000000"
  },
  "startTime": "2024-01-01T00:00:00.000Z",
  "co2eGramsPerKwh": 0.5,
  "costUsdPerKwh": 0.5,
  "costPerKwh": 0.5,
  "currency": {
    "currencyCode": "THB",
    "currencyName": "Chilean Peso"
  },
  "generation": 0,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

ingests

Upload and retrieve records of 3rd party ingests

Operations

datasources

Retrieve information about where data comes from

Operations