API Docs provide 3rd party developers (and customers) access to a set of REST APIs for interfacing with K2A applications. The REST API is currently in limited release. For information on how to use Swagger UI for API testing, see https://dzone.com/articles/how-to-use-swagger-ui-for-api-testing.
To access the Swagger UI API Docs:
- From the mega navigation, select API Docs.
On the API Docs landing page, select from the following options. (Available options may change.)
- Accounts
- Admin
- Agent Configurations
- Agents
- API Metadata
- Areas
- Authorization
- Campus
- Clients
- Company
- Contacts
- Devices
- Entity Mappings
- Equipment
- External Clients
- External Contacts
- External Equipment
- External Sites
- External Technicians
- FetchScoreFaultKPI
- Health Checks
- Health History
- Profiles
- Report Bookmarks
- Reports
- Rules
- Scoring
- Sensor Calculations
- Sensor Data
- Sensors
- Sites
- Subscriptions
- Systems
- Units
- Weather Data
- Weather Stations
- Worker Processes