142

Now Introducing – REST APIs

November 30, 2018 / 0 comments / in General  / by Eric Nakaki

In our continued efforts to allow our customers to interact with CygNet how they would like we are pleased to announce a new set of REST APIs in this upcoming release, due out at the end of this year. This opens up possibilities for rapid development of web-based dashboards and other tooling. 

For this release we focused on retrieving point, group, facility, real time, service, and history data. While there is still more to go we’re very excited with what we have managed to cover so far and believe that it will serve for quite a few use cases already. You can expect to see expanded functionality like alarms, notes, and the ability to send commands to CygNet in future releases.

Documentation and Examples

We decided that for these APIs we wanted to improve on traditional documentation. To facilitate this, we’ve added documentation pages about the APIs with example requests / responses and details about each request. On a deployed API system this can be found at <URL root>/CygNet/Help. It will deploy automatically when you install the new APIs.

Now Introducing - REST APIs - Screenshot

But that’s not all folks! We’ve also created a sample Angular web application to show examples of how to interact with the new APIs. If you like developing in Angular then you can use this as a great starting point to get a jump start on your new project! Otherwise it can help you to see how to interact with the APIs and then develop in whatever language you prefer. This will be released along with the new APIs.

Caches

We recently released a set of .NET caches which allow for cross service properties in a single request. So, if you wanted to know a real time value along with the units for that point, no longer does that require two separate calls (to your UIS and PNT). You can retrieve that in a single call. We have built some of the APIs using these caches both to improve performance on regularly requested values (we know that you’ll want to continually request some data) and to allow for these simplified combined calls.

Not just exposing existing features

While providing you an API to existing features like the great new .NET caches is valuable, and possibly to some of you new as they haven’t been out that long, we’ve also added some new features. An example of which is our call to provide you with all the leaf nodes in your group service under a specified group node. This is not just for a root hierarchy node, but any node in the group service.

Talk to your sales representative to learn more!

Share this entry
Share on Facebook Share on Twitter Share on Linkedin Share by Mail



Comments

Blog post currently doesn't have any comments.

Leave Comment

Subscribe to this blog post

Enter your email address to subscribe to this post and receive notifications of new comments by email.


Search the CygNet Blog

Subscribe to the CygNet Blog

Enter your email address to subscribe to this blog and receive notifications of new posts by email.

Tags