Specification Documents (OpenAPI 3.0)
Additional Information
Changelog
- Version 2.5.0 (28-Oct-2025)
- Projects, Units, and Plants:
- Added plantLatitude and plantlongitude fields to the /projects/summary, /units/summary, and /plants/summary endpoints.
- Projects (Environmental Equipment Key Needs):
- Added the following search parameter to the /projects/summary endpoint: envEquipKeyNeedsSCR, envEquipKeyNeedsSncr, envEquipKeyNeedsLowNoxBurn, envEquipKeyNeedsOverFiredAir, envEquipKeyNeedsDln, envEquipKeyNeedsFgdWet, envEquipKeyNeedsFgdDry, envEquipKeyNeedsFlueGasCondSys, envEquipKeyNeedsFlueGasRegenSys, envEquipKeyNeedsBaghouse, envEquipKeyNeedsEsp, envEquipKeyNeedsAcis, envEquipKeyNeedsFgdSea, envEquipKeyNeedsDsi, envEquipKeyNeedsCcr, envEquipKeyNeedsElg, envEquipKeyNeedsThirdStageSep, envEquipKeyNeedsThermOxi, envEquipKeyNeedsOxiCatalyst, envEquipKeyNeedsCyclones, envEquipKeyNeedsDustCollect, envEquipKeyNeedsCems, envEquipKeyNeedsFlare, envEquipKeyNeedsWetScrub, envEquipKeyNeedsDryScrub, envEquipKeyNeedsDustSuppSys, envEquipKeyNeedsBrokenBagDetect, envEquipKeyNeedsAshHandlingSys
- Added the environmentalEquipKeyNeeds object to the project/detail endpoint.
- Projects (Area Metrics):
- Added newSqMMin, newSqMMax, retrofittedSqMMin, and retrofittedSqMMax search parameters to the /projects/summary endpoint.
- Added existingSqMeters, newSqMeters, and retrofittedSqMeters fields to the /projects/detail endpoint.
- Plants:
- Added existingSqMMin and existingSqMMax search parameters to the /plants/summary endpoint.
- Added existingSqMeters field to the /plants/detail endpoint.
- Unit (Building and Production Areas):
- Added the following search parameters to the /units/summary endpoint:existBuildingAreaSqFtMin, existBuildingAreaSqFtMax, existBuildingAreaSqMMin, existBuildingAreaSqMMax, existProductAreaSqFtMin, existProductAreaSqFtMax, existProductAreaSqMMin, and existProductAreaSqMMax.
- Added the following fields to the /units/detail endpoint: existingBuildingAreaSqFeet, existingBuildingAreaSqMeters, existingProductAreaSqFeet, and existingProductAreaSqMeters.
- Unit (Capacity):
- Removed the actualCapacity and designCapacity fields from unitCapacity object in the units/detail endpoint.
- Added a capacity field to the unitCapacity object in the units/detail endpoint.
- Offline Events:
- Added heatRate field to the offlineevents/summary endpoint.
- Added derivedEventStatusDesc search parameter to the /offlineevents/summary endpoint, and added the derivedEventStatusDesc field to both /offlineevents/summary and /offlineevents/detail endpoints.
- Other Equipment:
- Added the following search parameters to the /otherequipment/summary endpoint: technology, model, containerCountMin, containerCountMax, solarPanelCountMin, solarPanelCountMax, inverterCountMin, inverterCountMax, transformerCountMin, transformerCountMax, kvRatingMin, and kvRatingMax.
- Added the following fields to the /otherequipment/detail endpoint: technology, model, containerCount, solarPanelCount, inverterCount, and stepUpTransformers (array of objects).
- Companies, Units, Boilers, Drives, Mining Equipment, Other Equipment, Pipelines and Transmission Lines:
- Added the releaseDate field to the summary endpoint.
- Version 2.4.5 (28-Oct-2025)
- Internal code maintenance.
- Version 2.3.3 (28-Oct-2025)
- Internal code maintenance.
- Version 2.4.4 (13-Oct-2025)
- Internal code maintenance.
- Version 2.3.2 (13-Oct-2025)
- Internal code maintenance.
- Version 2.4.3 (2-Sep-2025)
- Internal code maintenance.
- Version 2.3.1 (2-Sep-2025)
- Internal code maintenance.
- Version 2.4.2 (16-May-2025)
- Fixed an issue with the project details endpoint where plantSectors and projectSectors values were not being returned.
- Version 2.4.1 (25-Feb-2025)
- Added plantParentId, plantOwnerId and plantOperatorId search parameters to the plants summary endpoint.
- Added vendorFlag to the projects detail endpoint.
- Included bug fixes.
- Version 2.4.0 (21-Aug-2024)
- Added projectSectorDesc search parameter to the project summary endpoint.
- Added plantSectorDesc to the project, plant, unit, offline event, drive and boiler summary endpoints.
- Added projectSectors.projectSectorDesc and plantSectors.plantSectorDesc array of objects to the project detail endpoint.
- Added sectors.plantSectorDesc array of object to the plant, unit, offline event, boiler and drive detail endpoints.
- Removed unnecessary offshoreCountryName search parameter and field from all endpoints.
- Version 2.3.0 (19-Jun-2024)
- Introduced new endpoints for Pipeline Gas Flows, Pipeline Gas Flows Metadata, Pipeline Aggregates and Pipeline Aggregates Metadata.
- See v2.3 RapiDoc for additional info.
Show All
Hide