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

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

ingests

Upload and retrieve records of 3rd party ingests

Operations

Get all metadata of uploaded 3rd party device measurements.

Request

This returns the associated metadata of each uploaded 3rd party device measurement.

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 ingested records to return.

Default 10
Examples:
limit=10
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/ingests \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

ID of the returned record

items[].​typestringrequired

Type of returned record

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[].​namestring

Name of the record

items[].​descriptionstring

Description of the ingest

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

Upload a document with 3rd party device measurement data.

Request

Allows a user to upload power measurements for 3rd party devices from their own configured ITOM applications.

Security
bearer
Bodymultipart/form-datarequired
namestring

The name of the device measurements being uploaded.

descriptionstring

Description for this record

filestring(binary)

The 3rd party device measurement file. Must be .csv and matching the SIC third party data template. Maximum size is 300MB. Files that are invalid will not be consumed.

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/ingests \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data'

Responses

OK

Headers
Locationstring

Resource URI of the created ingest metadata

Bodyapplication/json
idstring(uuid)required

ID of the returned record

typestringrequired

Type of returned record

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.

namestring

Name of the record

descriptionstring

Description of the ingest

Response
application/json
{
  "id": "00000000-0000-0000-0000-0000000000000",
  "type": "sustainability-insight-ctr/ingest",
  "name": "3rd party data",
  "description": "Description A",
  "generation": 0,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

Get metadata for a 3rd party device measurement.

Request

Get metadata for an ingested 3rd party device measurement.

Security
bearer
Path
idstring(uuid)required

UUID of the record

Examples:

ID for the ingest metadata 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/ingests/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)required

ID of the returned record

typestringrequired

Type of returned record

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.

namestring

Name of the record

descriptionstring

Description of the ingest

Response
application/json
{
  "id": "00000000-0000-0000-0000-0000000000000",
  "type": "sustainability-insight-ctr/ingest",
  "name": "3rd party data",
  "description": "Description A",
  "generation": 0,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

datasources

Retrieve information about where data comes from

Operations