Performance Warehouse (REST)


This is a legacy REST interface. It is not available at https://<YourDTServerHost>:8021/api-docs/current/, however you can still execute it via any REST instrument.

The AppMon Server offers several RESTful interfaces to mange the Performance Warehouse connection settings and connection status. Use HTTP GET to get information about Performance Warehouse or HTTP PUT to modify the connection configuration and the connection status.

Connection status

GET connection status

Check if the Performance Warehouse is currently connected or not.

GET https://<server>:8021/rest/management/pwhconnection/status Produces application/xml
GET https://<server>:8021/rest/management/pwhconnection/status.xml Produces application/xml
GET https://<server>:8021/rest/management/pwhconnection/status.json Produces application/json

PUT connection status

Use the HTTP PUT interface to connect or disconnect the Performance Warehouse. The expected request content XML structure is similar to the response of the corresponding HTTP GET interface. Permissions are required to write to Repository configuration. An overloading POST interface provides the same output as HTTP PUT.

PUT https://<server>:8021/rest/management/pwhconnection/status Consumes application/xml
PUT https://<server>:8021/rest/management/pwhconnection/status.xml Consumes application/xml
PUT https://<server>:8021/rest/management/pwhconnection/status.json Consumes application/json

GET detailed connection status

Retrieve the current status of the performance warehouse connection.

GET https://<server>:8021/rest/management/pwhconnection/detailedstatus Produces application/xml
GET https://<server>:8021/rest/management/pwhconnection/detailedstatus.xml Produces application/xml
GET https://<server>:8021/rest/management/pwhconnection/detailedstatus.json Produces application/json

Connection configuration

GET connection configuration

Get a description of the current configuration of the Performance Warehouse connection.

GET https://<server>:8021/rest/management/pwhconnection/config Produces application/xml
GET https://<server>:8021/rest/management/pwhconnection/config.xml Produces application/xml
GET https://<server>:8021/rest/management/pwhconnection/config.json Produces application/json

PUT connection configuration

Use the HTTP PUT interface to set the performance warehouse connection settings by sending an XML or JSON representation as content of the request. The performance warehouse reconnects automatically. The expected XML/JSON structure of the request content is similar to the response of the corresponding HTTP GET interface. Permissions are required to write to Repository configuration.

PUT https://<server>:8021/rest/management/pwhconnection/config Consumes application/xml
PUT https://<server>:8021/rest/management/pwhconnection/config.xml Consumes application/xml
PUT https://<server>:8021/rest/management/pwhconnection/config.json Consumes application/json

For the dbms element within the connection configuration description the following values are valid: oracle, sqlserver, db2, postgresql, sqlazure, or embedded.