Description
btibAPI allows you to enable the API of the Active Framework. btibAPI is made of servlets. A servlet is a component that allows Niagara to receive requests from outside such as REST queries. There are different servlets for different purposes. They allow you to:
- Manipulate the model: create/delete a Node
- Assign a source to the model
- Interact with realtime data
- Read histories data
- Interact with alarms
- Add new components in a Niagara station
The public documentation of the API is available here: https://documenter.getpostman.com/view/6251608/Rzn9u2Tm
Implementation
Depending on what you want to allow to external users:
- Drag&Drop corresponding servlets in the WebService in the services of the station
- You can enable a LogExt to follow incoming requests
Notes
- Sometimes the server has a timezone slot. This slot is used in order to determine the timezone of dates/times, specially when working with schedules. Valid values are those included in the list of Java timezone ids, such as "Europe/Paris". A full list of timezone ids can be found here: https://docs.oracle.com/middleware/1221/wcs/tag-ref/MISC/TimeZones.html