The OpenAPI is used to export configuration and polled data for review. The OpenAPI lets you run queries that create custom Query URLs, which you can visit at any time to view your customized data. The OpenAPI stays constant when the internal data storage structure changes.
Unlike the data-driven and generic web services, the OpenAPI is a public API, and is meant for customer consumption. The OpenAPI uses the OData 2.0 industry standard. The documentation for this standard is found at the OData 2.0 Standard web page.
Note: Refer to the metadata to review the schema XML description. This description provides detailed information about the OpenAPI. To view the metadata navigate to the following URL:
http://<yourDA>:8581/odata/api/$metadata
If you add new metric families to the Data Aggregator, restart the Data Aggregator to update the OData schema in the OpenAPI. To restart the Data Aggregator, run the following command:
/etc/init.d/dadaemon restart
Important: This release of the QueryBuilder interface is in BETA, and we do NOT recommend using the interface in production environments. There are limitations in scalability and authorization options (single user and password).
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|