Get alert-definitions by thing-definition

  • 1 minute(s) read
Prev Next
Get
/inventory/thingDefinitions/{thingDefinitionId}/alertDefinitions

Returns the list of alert-definitions of a specific thing-definition.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Path parameters
thingDefinitionId
stringRequired

The thing-definition identifier.

Minimum1.0
Exampleabcd1234
Responses
200

Successful operation.

Array of object
object
id
string

The alert object identifier.

Exampleabcd1234
name
string

The alert name.

ExampleE503
title
string

The alert alternative title.

ExampleOverheating
description
string

The alert description.

ExampleHigh temperature detected
technicalDescription
string

The alert troubledshooting technical description.

ExampleHigh temperature occurs when....
severity
string

The event severity.

Valid values[ "WARNING", "CRITICAL", "INFORMATIONAL" ]
category
string

The event category.

Valid values[ "FAILURE", "ANOMALY", "INFORMATION" ]
eventSeverity
integer

event severity (1:FAILURE, 2:MAJOR ANOMALY, 3:MINOR ANOMALY, 4:OPERATION, 5:MAINTENANCE).

Valid values[ 1, 2, 3, 4, 5 ]
activeConditionPredicate
string

The active condition predicate.

Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL", "CONTAINS", "EXPIRED_BY_N_DAYS" ]
activeConditionSeparator
string

The active condition predicate separator char used in case of CONTAINS predicate.

activeConditionValue
string

The active condition value to check.

minimumActiveTime
integer

The minimum time the active condition must be true before activate the alert instance.

minimumActiveTimeUnit
string

The time unit releated to the minimum active time value.

Valid values[ "SECONDS", "MINUTES", "HOURS" ]
clearConditionPredicate
string

The clear condition predicate.

Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL", "CONTAINS", "EXPIRED_BY_N_DAYS" ]
clearConditionSeparator
string

The clear condition predicate separator char used in case of CONTAINS predicate.

clearConditionValue
string

The clear condition value to check.

alertActivatedNotificationTitle
string

The alert notification title.

Example${alert.severity}: ${thingDefinition.name} ${thing.serialNumber} - ${alert.title}
alertActivatedNotificationLongMessage
string

The long message notified when the alert is activated.

Example${alert.severity}: ${thing.serialNumber} - ${alert.title}
alertActivatedNotificationShortMessage
string

The long message notified when the alert is activated. This message is used for PUSH, SMS and VOICE notifications.

Example${alert.description}
alertClearedNotificationTitle
string

The alert clearing notification title.

Example${alert.severity}: ${thingDefinition.name} ${thing.serialNumber} - ${alert.title}
alertClearedNotificationLongMessage
string

The long message notified when the alert is cleared.

Example${alert.severity}: ${thing.serialNumber} - ${alert.title}
alertClearedNotificationShortMessage
string

The long message notified when the alert is cleared. This message is used for PUSH, SMS and VOICE notifications.

Example${alert.description}
delayedNotificationTime
integer

The minimum time the alert must remain active before being notified.

delayedNotificationTimeUnit
string

The time unit releated to the delayed time value.

Valid values[ "SECONDS", "MINUTES", "HOURS" ]
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error