When integrating with the API, the following general programming rules should be noted:
- fields will not always be returned in the same order; reference fields by name
- fields will not always be returned; validate a field is available before using it
- array results are not guaranteed to be sorted
- date and time fields will always be returned in ISO 8601 format
In addition to the reference below, the following resources are available to help you get started with the API.
API Examples
Each API example is available as an open source project on github, as well as posted as installable plugins on the Grid.
- Mobile UI: github | the Grid
- Network Performance Gauge: github | the Grid
- Incident Console: github | the Grid
- jQuery Example Library: github
Helper Classes
Helper classes that simplify access to and management of API functions are available here: