Cisco Cisco Prime Performance Manager 1.4 Developer's Guide

 

Cisco Prime Performance Manager REST API Guide 

Refer to Query String Parameters  

The Reports REST API is read-only. It only supports the HTTP GET verb. The following table shows an 
example of a URL and corresponding GET requests to retrieve a listing of {reportType} elements in 
JSON format.  Notice that jsonv2 corresponds to the newer JSON report format   

http://ppm-clean.cisco.com:4440/ppm/rest/{reportType}?outputType=jsonv2 

 

GET /ppm/rest/{reportType}?outputType=jsonv2 

Reports within PPM are grouped into the following reporting types {reportType}: 

Dashboards:  The dashboard provides a way to group different reports within a single page.  The 
REST API path to dashboard reports is /ppm/rest/dashboards. 

Reports: PPM Web Reports.  The REST API path to PPM web reports is 
/ppm/rest/reports. 

Grouped Reports: PPM allows the user to generate reports based on groups of network objects. 
The REST API path to grouped reports is /ppm/rest/groupreports. 

Tenant Reports: PPM allows this type to group reports targeted to specific customers. The REST 
API path to tenant reports is /ppm/rest/tenantreports. 

Prime Performance Manager reports are grouped by {category}. A category is a unique name in the Prime 
Performance Manager used to identify a group of dashboard reports, network/node level web reports, 
group reports and tenant reports.  

Categories consist of subcategories that form a hierarchical path to various reports in the system. 
Categories and sub-categories are followed by a report name to identify a specific report in the system. 

In order to retrieve a list of categories or report names, the GET URL should end at the root level or at a 
specific category or sub-category name. For example: 

GET /ppm/rest/{reportType}/ or GET /ppm/rest/{reportType}/{category}