GET api/impulses?afterId={afterId}&impulseData={impulseData}&geometryWKT={geometryWKT}
Gets the impulses.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteId |
Gets or sets the site identifier. |
integer |
None. |
| MeasurementId |
Gets or sets the measurement identifier. |
integer |
None. |
| Start |
Gets or sets the start. |
date |
None. |
| End |
Gets or sets the end. |
date |
None. |
| Duration |
Gets or sets the duration in seconds. |
decimal number |
None. |
| Threshold |
Gets or sets the threshold. |
integer |
None. |
| TimeOfMin | date |
None. |
|
| TimeOfMax | date |
None. |
|
| Severity | decimal number |
None. |
|
| Rank | integer |
None. |
|
| afterId |
Optional. This parameter restricts the response to impulses that have an Id that is greater than the specified Id. |
integer |
None. |
| impulseData |
Optional. Includes full data set for each impulse. This can only be used in conjunction with an Id filter. |
boolean |
Default value is False |
| geometryWKT | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ImpulseEventInfoModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets the identifier. |
integer |
None. |
| SiteId |
Gets or sets the site identifier. |
integer |
None. |
| MeasurementId |
Gets or sets the measurement identifier. |
integer |
None. |
| Start |
Gets or sets the start. |
date |
None. |
| End |
Gets or sets the end. |
date |
None. |
| Duration |
Gets or sets the duration in seconds. |
decimal number |
None. |
| DataMin |
Gets or sets the data minimum. |
decimal number |
None. |
| DataAvg |
Gets or sets the data average. |
decimal number |
None. |
| DataMax |
Gets or sets the data maximum. |
decimal number |
None. |
| UserUnits |
Gets or sets the units. |
string |
Max length: 12 |
| TimeOfMin | date |
None. |
|
| TimeOfMax | date |
None. |
|
| Severity | decimal number |
None. |
|
| Rank | integer |
None. |
|
| Links |
Gets the links. |
Collection of LinkModel |
None. |
Response Formats
application/json, text/json
[
{
"id": 1,
"siteId": 2,
"measurementId": 3,
"start": "2025-10-24T14:50:00.2327727+00:00",
"end": "2025-10-24T14:50:00.2327727+00:00",
"duration": 1.0,
"dataMin": 1.1,
"dataAvg": 1.1,
"dataMax": 1.1,
"userUnits": "sample string 5",
"timeOfMin": "2025-10-24T14:50:00.2483887+00:00",
"timeOfMax": "2025-10-24T14:50:00.2483887+00:00",
"severity": 1.1,
"rank": 1
},
{
"id": 1,
"siteId": 2,
"measurementId": 3,
"start": "2025-10-24T14:50:00.2327727+00:00",
"end": "2025-10-24T14:50:00.2327727+00:00",
"duration": 1.0,
"dataMin": 1.1,
"dataAvg": 1.1,
"dataMax": 1.1,
"userUnits": "sample string 5",
"timeOfMin": "2025-10-24T14:50:00.2483887+00:00",
"timeOfMax": "2025-10-24T14:50:00.2483887+00:00",
"severity": 1.1,
"rank": 1
}
]
application/xml, text/xml
<ArrayOfImpulseEventInfoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TelogWebAPI.Models">
<ImpulseEventInfoModel>
<DataAvg>1.1</DataAvg>
<DataMax>1.1</DataMax>
<DataMin>1.1</DataMin>
<Duration>1</Duration>
<End xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2327727Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</End>
<Id>1</Id>
<MeasurementId>3</MeasurementId>
<Rank>1</Rank>
<Severity>1.1</Severity>
<SiteId>2</SiteId>
<Start xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2327727Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</Start>
<TimeOfMax xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2483887Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</TimeOfMax>
<TimeOfMin xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2483887Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</TimeOfMin>
<UserUnits>sample string 5</UserUnits>
</ImpulseEventInfoModel>
<ImpulseEventInfoModel>
<DataAvg>1.1</DataAvg>
<DataMax>1.1</DataMax>
<DataMin>1.1</DataMin>
<Duration>1</Duration>
<End xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2327727Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</End>
<Id>1</Id>
<MeasurementId>3</MeasurementId>
<Rank>1</Rank>
<Severity>1.1</Severity>
<SiteId>2</SiteId>
<Start xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2327727Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</Start>
<TimeOfMax xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2483887Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</TimeOfMax>
<TimeOfMin xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-10-24T14:50:00.2483887Z</d3p1:DateTime>
<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
</TimeOfMin>
<UserUnits>sample string 5</UserUnits>
</ImpulseEventInfoModel>
</ArrayOfImpulseEventInfoModel>