Alert API

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to API Reference

You cannot access alert information directly through the API, but some of the APIs provide information about alert resources.

Alert Fields

Alert resources may provide the following fields:

Item Example Description

"id"

"54"

An integer that uniquely identifies the alert.

"alertType"

"Value"

The type of the alert.

"alertValue"
(only if "alertType": "Value")

"Moderate"

A value to filter.

The alert only affects the target security property or enterprise data dictionary attachment if its value is the specified value.

"alertLevel"

"Info"

The level of the alert. Possible values are:

  • "Info"
  • "Notice"

"alertText"

"This resource contains sensitive data"

The text of the alert.

"securityproperty"

"id": "3804",

The security property affected by this alert. This field provides the following information about the affected security property:

  • id

See the Security Property API for more information.

"type"

"Alert"

The type of the resource. Its value is always "Alert" for alert resources.

See Also

Personal tools
Product Videos