Cisco Cisco Prime Performance Manager 1.7 Developer's Guide
Cisco Prime Performance Manager 1.7 REST API Guide
Reports: Prime Performance Manager Web Reports. The REST API path to Prime Performance
Manager web reports is /ppm/rest/reports.
Manager web reports is /ppm/rest/reports.
Grouped Reports: Prime Performance Manager allows users to generate reports based on groups
of network objects. The REST API path to grouped reports is /ppm/rest/groupreports.
of network objects. The REST API path to grouped reports is /ppm/rest/groupreports.
Views Reports: Prime Performance Manager allows the user to create views and copy/paste
reports to separate views. The REST API path to view reports is /ppm/rest/views.
reports to separate views. The REST API path to view reports is /ppm/rest/views.
TCAs Reports: Prime Performance Manager allows the user to retrieve TCA (Threshold
Crossing Alerts) data. The REST API path to the TCA report is /ppm/rest/tcas.
Crossing Alerts) data. The REST API path to the TCA report is /ppm/rest/tcas.
Note: When querying views from the REST API, the user is recommended to name that view
uniquely to differentiate it from other views. For example, the user might consider prepending
the word “REST” to the view name to help identify that view as being used from the REST API;
for example – “REST <some view name>”
uniquely to differentiate it from other views. For example, the user might consider prepending
the word “REST” to the view name to help identify that view as being used from the REST API;
for example – “REST <some view name>”
5.5.2 Report Listing (Report Categories and Report Names)
Prime Performance Manager reports are grouped by {category}. A category is a unique Prime
Performance Manager name that identifies a group of dashboard reports, network/node level web reports,
and group reports.
Performance Manager name that identifies a group of dashboard reports, network/node level web reports,
and group 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.
Categories and sub-categories are followed by a report name to identify a specific report in the system.
To retrieve a list of categories or report names, end the GET URL at the root level or at a specific
category or sub-category name. For example:
category or sub-category name. For example:
GET /ppm/rest/{reportType}/ or GET /ppm/rest/{reportType}/{category}
Table 5 – List of Report Examples
Resource Name
Description
/{reportType}
The list of all top-level report categories for the {reportType}.
/{reportType}/{category}..
The list of report subcategories or report names available for that category.
An empty {category} implies the root category that shows all the top
{reportType} categories.
An empty {category} implies the root category that shows all the top
{reportType} categories.
/dashboards/Application+Dashboards/ List all dashboard reports subcategories and dashboard reports names (if
any) under the Application Dashboards category.
/reports/Availability
List all reports subcategories and reports (if any) under the “Availability”
category.
category.
/groupreports/Transport+Statistics
List all group reports subcategories and group reports names (if any) under
the “Transport Statistics” category.
the “Transport Statistics” category.
/views
List all the top views.
/views/Data+Center
List all the sub-views under the “Data Center” view.
5.5.3 Reports
The REST API allows users to retrieve all the reports available within the Prime Performance Manager
system using HTTP GET URLs containing the corresponding full path to that report name. The Prime
Performance Manager reports are uniquely identified by {reportType}, {category} and a {reportName}.
system using HTTP GET URLs containing the corresponding full path to that report name. The Prime
Performance Manager reports are uniquely identified by {reportType}, {category} and a {reportName}.