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: [ Missing, Estimated, Metered, Extrapolated, Planned, Simulated, Unspecified, Normalised, Calculated based on estimated data, Calculated based on metered data, Calculated based on extrapolated data, Calculated based on planned data, Calculated based on simulated data, Calculated based on data with unspecified accuracy, Calculated based on normalised data, Projection based on estimated data, Projection based on metered data, Projection based on extrapolated data, Projection based on planned data, Projection based on simulated data, Projection based on data with unspecified accuracy, Projection based on normalised data, Calculated based on projected estimated data, Calculated based on projected metered data, Calculated based on projected extrapolated data, Calculated based on projected planned data, Calculated based on projected simulated data, Calculated based on projected data with unspecified accuracy, Calculated based on projected normalised data, Retrofit scenario, Implausible, Calculated based on implausible data, Calculated based on projected implausible data, Projection based on implausible data ]
buildingId	string	Unique identifier of buildings in the BuildingMinds platform ;minLength: 1 maxLength: 50 (Mandatory)
customerInfoSource	string, Enum	Enum: [ Export, Survey, Meter, Invoice ]
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: [ OperationalMeasurementAdded, OperationalMeasurementUpdated, OperationalMeasurementDeleted ]
extensionData	string	this object stores any additional meta data related to this OPM ;maximum: 9999
isAutoApproved	boolean	Y/N Determines whether this value is auto approved for operational measurement or requires an approval.
lifeCycleAssessment	string, array	Related life cycle assessment stage according to ISO 14040 Enum: [ A1, A2, A3, A4, A5, B1, B2, B3, B4, B5, B6, B7, C1, C2, C3, C4, D ]
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: [ Procured by third party, Self-procured, Unspecified ]
purpose *	string	Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas Enum: [ Space heating, Water heating, Heating (unspecified), Cooling, Lighting, Elevator, Appliances, Other, Unspecified, Heat pump, EV charging ]
sensorId	string	ID of meter of this reading. (Optional)
spaceType *	string	Reference to specific space type (or 'whole building') Enum: [ Shared services/Common spaces, Tenant space, Landlord space, Whole building, Unspecified, Shared services, Common spaces, Outdoor, Exterior area, Parking ]
subType *	string	Specific type of operational measurement e.g. district heating or water discharge Enum: [ Electricity from grid (green electricity contract), Electricity self-generated & exported, Electricity self-generated & consumed, Electricity (unspecified), REC, Natural gas (standard mix), Green natural gas, Natural gas (unspecified), Oil-based fuels, Fuel (unspecified), District heating, District cooling, Biomass, Solar thermal, Fresh water (municipal water supply), Ground water (collected on site), Rain water (collected on site), Reclaimed water, Water discharge, Water consumption (unspecified), Recycling: non-hazardous, Incineration: non-hazardous, Waste to energy: non-hazardous, Other/Unknown: hazardous, Other/Unknown: non-hazardous, Electricity from grid (normal contract), Carbon dioxide (CO2), Methane (CH4), Nitrous oxide (N2O), R-11 \| CFC-11 \| Trichlorofluoromethane (CCI3F), R-12 \| CFC-12 \| Dichlorofluoromethane (CCI2F2), R-13 \| CFC-13 \| Chlorodifluoromethane (CCIF3), R-113 \| CFC-113 \| 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3), R-114 \| CFC-114 \| Halon-242 \| 1,2-Dichlorotetrafluoroethane (C2Cl2F4), R-115 \| CFC-115 \| Chloropentafluoroethane (C2ClF5), R13 B1 \| Halon-1301 \| Bromotrifluoromethane (CBrF3), R-12B1 \| Halon-1211 \| Bromochlorodifluoromethane (CBrCIF2), R 114B2 \| Halon-2402 \| 1,2-Dibromotetrafluoroethane (C2Br2F4), R-10 \| Carbon tetrachloride (CCl4), Bromomethane \| Methyl bromide (CH3Br), R-140a \| 1,1,1- Trichloroethane \| Methyl chloroform (C2H3Cl3), R-21 \| HCFC-21 \| Dichlorofluoromethane (CHCl2F), R-22 \| HCFC-22 \| Chlorodifluoromethane (CHClF2), R-123 \| HCFC-123 \| 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3), R-124 \| HCFC-124\| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4), R-141b \| HCFC-141b \|1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F), R-142b \| HCFC-142b \| 1-Chloro-1,1,-difluoroethane (C2ClF2), R-225ca \| HCFC-225ca \| 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5), R-225cb \| HCFC-225cb \| 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5), R-23 \| HFC-23 \|, R-32 \| HFC-32 \|, R-41 \| HFC-41 \|, R-125 \| HFC-125 \|, R-134 \| HFC-134 \|, R-134a \| HFC-134a \|, R-143 \| HFC-143 \|, R-143a \| HFC-143a \|, R-152 \| HFC-152 \|, R-152a \| HFC-152a \|, R-161 \| HFC-161 \|, R-227ea \| HFC-227ea \|, R-236cb \| HFC-236cb \|, R-236ea \| HFC-236ea \|, R-236fa \| HFC-236fa \|, R-245ca \| HFC-245ca \|, R-245fa \| HFC-245fa \|, R-365mfc \| HFC-365mfc \|, R-43-10mee \| HFC-43-10mee \|, Sulfur hexafluoride (SF6), Nitrogen trifluoride (NF3), Water supply, Landfill: non-hazardous, Reuse: non-hazardous, Waste to energy: hazardous, Incineration: hazardous, Landfill: hazardous, Recycling: hazardous, Reuse: hazardous, Geothermal, District heating (green contract), District cooling (green contract) ]
type *	string	General type of operational measurement e.g. energy, water or waste Enum: [ Energy, Water, Waste, Fugitive ]
unit *	string	Unit of operational measurement e.g. 'kWh' or 'cubm' Enum: [ kWh, cubm, kg ]
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