Operational Measurements
This page will familiarize you with the building endpoint.
Description
This endpoint allows users to directly send aggregated consumption data to be used for operational measurements against a building. If you are aggregating consumption readings from meters or invoices directly in your system and want to pass that info to BuildingMinds platform, then use this endpoint.
Create OPM value
POST Request: {{BASE_URL}}/operational-measurement
Pre-Requisite: For an operational measurement or aggregated consumption value to be added via BuildingMinds API, building/s must be on-boarded with a buildingId.
Field Attributes
Field | Type | Description |
|---|---|---|
accuracy | string, Enum | Enum: |
buildingId | string | Unique identifier of buildings in the BuildingMinds platform ;minLength: 1 maxLength: 50 (Mandatory) |
customerInfoSource | string, Enum | Enum: |
dataProvider | string, | Name of the data provider. ;minLength: 1 maxLength: 50 |
eventType | string | Type of the event as specific domain event. Please pass the enums accordingly to add, update or delete the OPM value. Enum: |
extensionData | string | this object stores any additional meta data related to this OPM ;maximum: 9999 |
isAutoApproved | boolean | Y/N |
lifeCycleAssessment | string, array | Related life cycle assessment stage according to ISO 14040 Enum: |
measurementDate | string | Date of measurement is taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
name | string | any name |
operationalMeasurementId * | string | Unique identifier either coming from previous system otherwise it needs to be define |
parentId | string | Parent (guid or id) of entity |
postingDate | string | Date of measurement posting in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
procuredBy * | string | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol Enum: |
purpose * | string | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas Enum: |
sensorId | string | ID of meter of this reading. (Optional) |
spaceType * | string | Reference to specific space type (or 'whole building') Enum: |
subType * | string | Specific type of operational measurement e.g. district heating or water discharge Enum: |
type * | string | General type of operational measurement e.g. energy, water or waste Enum: |
unit * | string | Unit of operational measurement e.g. 'kWh' or 'cubm' Enum: |
validFrom * | string | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
validUntil * | string | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
valuationIds | string, array | Array of valuation IDs |
value * | string, number | Value of individual operational measurement |
[
{
"accuracy": "Missing",
"buildingId": "string",
"customerInfoSource": "Export",
"dataProvider": "string",
"eventType": "OperationalMeasurementAdded",
"extensionData": {},
"isAutoApproved": true,
"lifeCycleAssessment": "A1",
"measurementDate": "string",
"name": "string",
"operationalMeasurementId": "string",
"parentId": "string",
"postingDate": "string",
"procuredBy": "Procured by third party",
"purpose": "Space heating",
"sensorId": "string",
"spaceType": "Shared services/Common spaces",
"subType": "Electricity from grid (green electricity contract)",
"type": "Energy",
"unit": "kWh",
"validFrom": "string",
"validUntil": "string",
"valuationIds": [
"string"
],
"value": 0
}
]Update Operational Measurements
The message remains the same. The only change will be in the**"eventType": "OperationalMeasurementUpdated"**.
POST Request: {{BASE_URL}}/operational-measurement
[
{
"accuracy": "Missing",
"buildingId": "string",
"customerInfoSource": "Export",
"dataProvider": "string",
"eventType": "OperationalMeasurementUpdated",
"extensionData": {},
"isAutoApproved": true,
"lifeCycleAssessment": "A1",
"measurementDate": "string",
"name": "string",
"operationalMeasurementId": "string",
"parentId": "string",
"postingDate": "string",
"procuredBy": "Procured by third party",
"purpose": "Space heating",
"sensorId": "string",
"spaceType": "Shared services/Common spaces",
"subType": "Electricity from grid (green electricity contract)",
"type": "Energy",
"unit": "kWh",
"validFrom": "string",
"validUntil": "string",
"valuationIds": [
"string"
],
"value": 0
}
]Delete Operational Measurements
The message remains the same. The only change will be in the**"eventType": "OperationalMeasurementDeleted"**.
POST Request: {{BASE_URL}}/operational-measurement
[
{
"accuracy": "Missing",
"buildingId": "string",
"customerInfoSource": "Export",
"dataProvider": "string",
"eventType": "OperationalMeasurementDeleted",
"extensionData": {},
"isAutoApproved": true,
"lifeCycleAssessment": "A1",
"measurementDate": "string",
"name": "string",
"operationalMeasurementId": "string",
"parentId": "string",
"postingDate": "string",
"procuredBy": "Procured by third party",
"purpose": "Space heating",
"sensorId": "string",
"spaceType": "Shared services/Common spaces",
"subType": "Electricity from grid (green electricity contract)",
"type": "Energy",
"unit": "kWh",
"validFrom": "string",
"validUntil": "string",
"valuationIds": [
"string"
],
"value": 0
}
]View Status of Operational Measurements
Based on the batchID generated you can GET the batch of the on-boarded operational measurements with the below-mentioned request. This will be the same for both update and delete.
GET Request:{{BASE_URL}}/batch/{id}/inbound
Updated 23 days ago