API Reference

Alerts are insights that are generated from the PEAK Rules Engine when a deployed rule goes into fault and can be linked to action

Refer to CIM Help Centre for an explanation of how alert work (support link).

Alert ids

Overview of default alert ids, descriptions, and associations found in the action payload.

equipment_ids

The id of all the equipment associated with the action. Query the Equipment endpoint for details.

status_id

status_idDescription
1Open
2Acknowledged
3In Progress
4Actioned
5In review
6Closed