Introduction

This section explains how to extract the definition of alerts created in the Gear Studio platform using the data extraction API. Alerts allow defining conditions that, once met, generate the corresponding alarms. When values return to normal, previously created alarms are automatically closed.

To report alerts, the alert data type is used, whose documentation can be found here.

There are three mechanisms for obtaining alert information:

Get data for a specific alert by its ID, as explained here.
Get information for all alerts associated with an endpoint, device, facility, or client. Documentation can be found here.
Get information for all alerts associated with an endpoint, device, facility, or client, incrementally. Documentation can be found here.

Introduction

To report alerts, the alert data type is used, whose documentation can be found here.

There are three mechanisms for obtaining alert information:

Get data for a specific alert by its ID, as explained here.
Get information for all alerts associated with an endpoint, device, facility, or client. Documentation can be found here.
Get information for all alerts associated with an endpoint, device, facility, or client, incrementally. Documentation can be found here.

Alerts

Introduction

On this page

Alerts

Introduction

On this page