Momentum Energi External Web Api (/api/external)
External REST API for customers and suppliers to Momentum Software AB.
/api/external/v1/statistics
Controller for delivering statistics data upon requests
| API | Description |
|---|---|
| GET /api/external/v1/statistics/bykey/{key}/{periodStart}/{periodEnd}/groupbymedia |
Get monthly statistics data for certain item in the structure and period grouped by media type. |
| GET /api/external/v1/statistics/bykey/{key}/{periodStart}/{periodEnd}/groupbyusage |
Get monthly statistics data for certain item in the structure and period grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
| GET /api/external/v1/statistics/bykey/{key}/updatedAfter/{updatedAfter}/groupbymedia |
Deprecated! Use corresponding endpoint in API V2 instead. Get monthly statistics data of any time period for a certain item in the structure that has one or more media types that are updated after a certain date. The result includes all media types for each item, regardless if the media type has been updated or not. The result is grouped by media type. |
| GET /api/external/v1/statistics/bykey/{key}/updatedAfter/{updatedAfter}/groupbyusage |
Deprecated! Use corresponding endpoint in API V2 instead. Get monthly statistics data of any time period for a certain item in the structure and that has one or more usage types that are updated after a certain date. The result includes all usage types for each structure item, regardless if the usage group has been updated or not. The result is grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
| GET /api/external/v1/statistics/bylevel/{level}/{periodStart}/{periodEnd}/groupbymedia |
Get monthly statistics data for certain structure level and period grouped by media type. |
| GET /api/external/v1/statistics/bylevel/{level}/{periodStart}/{periodEnd}/groupbyusage |
Get monthly statistics data for certain structure level and period grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
| GET /api/external/v1/statistics/bylevel/{level}/updatedAfter/{updatedAfter}/groupbymedia |
Deprecated! Use corresponding endpoint in API V2 instead. Get monthly statistics data of any time period and for a certain level in the structure that has one or more media types that are updated after a certain date. The result includes all media types for each structure item, regardless if the media type has been updated or not. The statistics are grouped by media type. |
| GET /api/external/v1/statistics/bylevel/{level}/updatedAfter/{updatedAfter}/groupbyusage |
Deprecated! Use corresponding endpoint in API V2 instead. Get monthly statistics data of any time period and for a certain level in the structure and that has one or more usage types that are updated after a certain date. The result includes all usage types for each structure item, regardless if the usage group has been updated or not. The statistics are grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
/api/external/v1/structure
Controller for delivering structure data upon requests.
| API | Description |
|---|---|
| GET /api/external/v1/structure/{level} |
Get all items in structure matching requested level. |
/api/external/v2/statistics
Controller for delivering statistics data upon requests
| API | Description |
|---|---|
| GET /api/external/v2/statistics/bykey/{key}/{periodStart}/{periodEnd}/groupbymedia |
Get monthly statistics data for certain item in the structure and period grouped by media type. |
| GET /api/external/v2/statistics/bykey/{key}/{periodStart}/{periodEnd}/groupbyusage |
Get monthly statistics data for certain item in the structure and period grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
| GET /api/external/v2/statistics/bykey/{key}/updatedAfter/{updatedAfter}/groupbymedia |
Get monthly statistics data of any time period for a certain item in the structure that has one or more media types that are updated after a certain date. The result includes only the media types for each item that have been updated. For a full set of statistics for each item, please use the end points where you can specify a date interval instead. The result is grouped by media type. |
| GET /api/external/v2/statistics/bykey/{key}/updatedAfter/{updatedAfter}/groupbyusage |
Get monthly statistics data of any time period for a certain item in the structure and that has one or more usage types that are updated after a certain date. The result includes only usage types for each structure item that have been updated. For a full set of statistics for each item, please use the end points where you can specify a date interval instead. |
| GET /api/external/v2/statistics/bylevel/{level}/{periodStart}/{periodEnd}/groupbymedia |
Get monthly statistics data for certain structure level and period grouped by media type. |
| GET /api/external/v2/statistics/bylevel/{level}/{periodStart}/{periodEnd}/groupbyusage |
Get monthly statistics data for certain structure level and period grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
| GET /api/external/v2/statistics/bylevel/{level}/updatedAfter/{updatedAfter}/groupbymedia |
Get monthly statistics data of any time period and for a certain level in the structure that has one or more media types that are updated after a certain date. The result includes only media types for each structure item that have been updated. For a full set of statistics for each item, please use the end points where you can specify a date interval instead. The statistics are grouped by media type. |
| GET /api/external/v2/statistics/bylevel/{level}/updatedAfter/{updatedAfter}/groupbyusage |
Get monthly statistics data of any time period and for a certain level in the structure that has one or more usage types that are updated after a certain date. The result includes only usage types for each structure item that have been updated. For a full set of statistics for each item, please use the end points where you can specify a date interval instead. The statistics are grouped by usage type. If there are multiple media types in the result set with different units, the result set will also be grouped by media type unit. |
/api/external/v2/structure
Controller for delivering structure data upon requests.
| API | Description |
|---|---|
| GET /api/external/v2/structure/{level} |
Get all items in structure matching requested level. |
/api/external/v3/notes
Controller for delivering published notes data upon requests.
| API | Description |
|---|---|
| GET /api/external/v3/notes/{key} |
Retrieves all published notes associated with the specified space and its underlying objects. |
| GET /api/external/v3/notes/{key}/{date} |
Retrieves all published notes associated with the specified object and its underlying objects since date |
/api/external/v3/statistics
Controller for delivering facility statistics data upon requests.
| API | Description |
|---|---|
| GET /api/external/v3/statistics/facility/day/key/{key}/{start}/{end} |
Get daily statistics data for a specific facility between start and end date. |
| GET /api/external/v3/statistics/facility/day/key/{key}/updated-after/{date} |
Get all daily data points for a specific facility that have been updated after a specific date. |
| GET /api/external/v3/statistics/facility/day/space-key/{key}/{start}/{end} |
Get daily statistics data for a all facilities located under a specific space between start and end date. |
| GET /api/external/v3/statistics/facility/day/space-key/{key}/updated-after/{date} |
Get daily statistics data for a all facilities located under a specific space that have been updated after a specific date. |
| GET /api/external/v3/statistics/facility/day/space-level/{ordinal}/{start}/{end} |
Get daily statistics data for all facilities located under a space level between start and end date. |
| GET /api/external/v3/statistics/facility/day/space-level/{ordinal}/updated-after/{date} |
Get daily statistics data for all facilities located under a space level that have been updated after a specific date. |
| GET /api/external/v3/statistics/facility/month/key/{key}/{start}/{end} |
Get monthly statistics data for a specific facility between start and end date. |
| GET /api/external/v3/statistics/facility/month/key/{key}/updated-after/{date} |
Get all data points for a specific facility that have been updated after a specific date. |
| GET /api/external/v3/statistics/facility/month/space-key/{key}/{start}/{end} |
Get monthly statistics data for a all facilities located under a specific space between start and end date. |
| GET /api/external/v3/statistics/facility/month/space-key/{key}/updated-after/{date} |
Get monthly statistics data for a all facilities located under a specific space that have been updated after a specific date. |
| GET /api/external/v3/statistics/facility/month/space-level/{ordinal}/{start}/{end} |
Get monthly statistics data for all facilities located under a space level between start and end date. |
| GET /api/external/v3/statistics/facility/month/space-level/{ordinal}/updated-after/{date} |
Get monthly statistics data for all facilities located under a space level that have been updated after a specific date. |
| GET /api/external/v3/statistics/space/key/{key}/{start}/{end}/energy-usage |
Get monthly statistics data for a specific space in the structure, between start and end date, grouped by usage type. |
| GET /api/external/v3/statistics/space/key/{key}/{start}/{end}/media |
Get monthly statistics data for a specific space in the structure, between start and end date, grouped by media. |
| GET /api/external/v3/statistics/space/key/{key}/{start}/{end}/media-usage |
Get monthly statistics data for a specific space in the structure, between start and end date, grouped by media and usage. |
| GET /api/external/v3/statistics/space/key/{key}/updated-after/{date}/energy-usage |
Get all monthly data points for a specific space that have been updated after a specific date, grouped by usage type. |
| GET /api/external/v3/statistics/space/key/{key}/updated-after/{date}/media |
Get all monthly data points for a specific space that have been updated after a specific date, grouped by media. |
| GET /api/external/v3/statistics/space/key/{key}/updated-after/{date}/media-usage |
Get all monthly data points for a specific space that have been updated after a specific date, grouped by media and usage. |
| GET /api/external/v3/statistics/space/level/{ordinal}/{start}/{end}/energy-usage |
Get monthly statistics data for a space level in the structure, between start and end date, grouped by usage type. |
| GET /api/external/v3/statistics/space/level/{ordinal}/{start}/{end}/media |
Get monthly statistics data for a space level in the structure, between start and end date, grouped by media. |
| GET /api/external/v3/statistics/space/level/{ordinal}/{start}/{end}/media-usage |
Get monthly statistics data for a space level in the structure, between start and end date, grouped by media and usage. |
| GET /api/external/v3/statistics/space/level/{ordinal}/updated-after/{date}/energy-usage |
Get all monthly data points for a space level that have been updated after a specific date, grouped by usage type. |
| GET /api/external/v3/statistics/space/level/{ordinal}/updated-after/{date}/media |
Get all monthly data points for a space level that have been updated after a specific date, grouped by media. |
| GET /api/external/v3/statistics/space/level/{ordinal}/updated-after/{date}/media-usage |
Get all monthly data points for a space level that have been updated after a specific date, grouped by media and usage. |
/api/external/v3/structure
Controller for delivering structure data upon requests.
| API | Description |
|---|---|
| GET /api/external/v3/structure/levels |
Get all available space levels. |