OpenAPI

The OpenAPI is a flexible tool that lets users easily extract data from the capm database. The OpenAPI enables integration between capm data and external applications.
capm270
HID_OpenAPI
The OpenAPI is a flexible tool that lets users easily extract data from the
DX NetOps Performance Management
database. The OpenAPI enables integration between
DX NetOps Performance Management
data and external applications.
The OpenAPI is a public API that uses the QueryBuilder GUI. The QueryBuilder is a guided URL builder that lets you create custom Query URLs to extract and explore performance data. The URLs return customized data in the specified format. You can view the data in a browser or process the data in a custom web application.
The OpenAPI uses the OData 2.0 industry standard. The documentation for this standard is found at the OData 2.0 web page.
When new metrics families are added to the system, the metrics are automatically added to the OpenAPI schema.
Access the OpenAPI
All users who have
NetOps Portal
credentials can use QueryBuilder and the OpenAPI. To log in to the OpenAPI QueryBuilder, use your
NetOps Portal
credentials. The OpenAPI uses Single Sign-On (SSO) for credential authentication.
If the PC hostname is overridden, the Web Service Host must be updated using the Single Sign-On Configuration Tool. Otherwise, QueryBuilder cannot access SSO to log in users. If you override the PC hostname, update the Web Service Host property in the Single Sign-On Configuration Tool. For more information, see Update Performance Center Website Settings.
To access the QueryBuilder, go to the following URL:
http://
DA_host
:8581/odataquery
In a fault tolerant environment, specify the proxy server as the
DA_host
.
You
cannot
run OpenAPI queries outside the QueryBuilder as a user with Security Assertion Markup Language (SAML) 2.0 authentication. SAML authentication works in the QueryBuilder UI. LDAP authentication and
NetOps Portal
authentication support direct OpenAPI queries.
The schema XML description provides detailed information about the items and relationships in your system. To review the schema XML description and metadata, go to the following URL:
http://
DA_host
:8581/odata/api/$metadata