Alerts created from these sensor data give you information about the condition of the Technical Object. The information provided helps you with any potential failure that may occur or has already occurred for the Technical Object and helps to identify potential actions to be taken for the incoming alerts.This service is located at [/AlertsService/v1/Alert]
Retrieve a list of alert. (alertGet)
Query parameters
$top (optional)
Query Parameter — Show only the first n items, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop">Paging - Top</a>
$skip (optional)
Query Parameter — Skip the first n items, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip">Paging - Skip</a>
$search (optional)
Query Parameter — Search items by search phrases, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch">Searching</a>
$filter (optional)
Query Parameter — Filter items by property values, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter">Filtering</a>
$count (optional)
Query Parameter — Include count of items, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount">Count</a>
$orderby (optional)
Query Parameter — Order items by property values, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby">Sorting</a>
$select (optional)
Query Parameter — Select properties to be returned, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect">Select</a>
$expand (optional)
Query Parameter — The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand">Expand</a>
Return type
Example data
Content-Type: application/json
{
"@odata.count" : "",
"value" : [ {
"TriggeredOn": "2024-05-16T06:01:08.846Z",
"Id": "427ee2ed-bbfd-425e-9f52-b1ae52be79bc",
"FirstOccurredOn": "2024-05-16T06:01:08.846Z",
"LastOccurredOn": "2024-05-16T06:01:08.846Z",
"UpdatedOn": "2024-05-16T06:10:26.021Z",
"AlertTypeDescription": "Sep-18",
"AlertType": "TestPublicAlert",
"Status": "10",
"StatusDescription": "In_Process",
"Severity": 5,
"SeverityDescription": "Warning",
"Source": "API",
"DeduplicationCount": "0"
}, {
"TriggeredOn": "2024-05-16T06:01:08.846Z",
"Id": "427ee2ed-bbfd-425e-9f52-b0ae52be89bc",
"FirstOccurredOn": "2024-05-16T06:01:08.846Z",
"LastOccurredOn": "2024-05-16T06:01:08.846Z",
"UpdatedOn": "2024-05-16T06:10:26.021Z",
"AlertTypeDescription": "Sep-18",
"AlertType": "TestPublicAlert",
"Status": "10",
"StatusDescription": "In_Process",
"Severity": 5,
"SeverityDescription": "Warning",
"Source": "API",
"DeduplicationCount": "0"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Retrieved alert
Collection of Alert
4XX
Error
error
Retrieve a single alert. (alertIdGet)
Path parameters
Id (required)
Path Parameter — key: Id
Query parameters
$select (optional)
Query Parameter — Select properties to be returned, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect">Select</a>
$expand (optional)
Query Parameter — The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see <a href="http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand">Expand</a>
Return type
Example data
Content-Type: application/json
{
"TriggeredOn": "2024-05-16T06:01:08.846Z",
"Id": "427ee2ed-bbfd-425e-9f52-b1ae52be79bc",
"FirstOccurredOn": "2024-05-16T06:01:08.846Z",
"LastOccurredOn": "2024-05-16T06:01:08.846Z",
"UpdatedOn": "2024-05-16T06:10:26.021Z",
"AlertTypeDescription": "Sep-18",
"AlertType": "TestPublicAlert",
"Status": "10",
"StatusDescription": "In_Process",
"Severity": 5,
"SeverityDescription": "Warning",
"Source": "API",
"DeduplicationCount": "0"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Retrieved alert
PublicAlertsService.Alert
4XX
Error
error
Change a single alert. (alertIdPatch)
Path parameters
Id (required)
Path Parameter — key: Id
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — New property values
{
"Status": "10"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Success
4XX
Error
error
Create a single alert. (alertPost)
{
"AlertType": "TestPublicAlert",
"TriggeredOn": "2024-05-16T06:01:08.846Z",
"TechnicalObject": [
{
"Number": "10000001",
"SSID": "QM7_910",
"Type": "EQUI"
}
]
}
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — New alert
Return type
Example data
Content-Type: application/json
{
"TriggeredOn": "2024-05-16T06:01:08.846Z",
"Id": "427ee2ed-bbfd-425e-9f52-b1ae52be79bc",
"FirstOccurredOn": "2024-05-16T06:01:08.846Z",
"LastOccurredOn": "2024-05-16T06:01:08.846Z",
"UpdatedOn": "2024-05-16T06:10:26.021Z",
"AlertTypeDescription": "Sep-18",
"AlertType": "TestPublicAlert",
"Status": "10",
"StatusDescription": "In_Process",
"Severity": 5,
"SeverityDescription": "Warning",
"Source": "API",
"DeduplicationCount": "0"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Created alert
PublicAlertsService.Alert
4XX
Error
error