Cisco Cisco Prime Performance Manager 1.5 Developer's Guide
Cisco Prime Performance Manager1.5 REST API Guide
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}.
The REST API report response contains the reporting data associated with the requested report filtered
by any query string parameters found in the URL.
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}.
The REST API report response contains the reporting data associated with the requested report filtered
by any query string parameters found in the URL.
Example: GET /ppm/rest/{reportType}/{category}../{reportName}?{queryString}
Note: {queryString} parameters like FQDN, sgmid, startDate, endDate, intervalTypeKey, duration, and
others are used to filter out the reporting data returned from the system. The FQDN parameter or sgmid
query string parameters are used when a specific node level report or group level report is required.
others are used to filter out the reporting data returned from the system. The FQDN parameter or sgmid
query string parameters are used when a specific node level report or group level report is required.
Table 6 – Path for a Network Level Report
Resource Name
Description
/reports/Availability/ICMP+Ping/ICMP+Ping+Availability
A report identified by the {reportName}
“ICMP Ping Availability” which is part of
the “ICMP Ping” sub {category} and
“Availability” {category}.
“ICMP Ping Availability” which is part of
the “ICMP Ping” sub {category} and
“Availability” {category}.
5.6 URL Encoding
Encode the URL according to the Internet URL RFC 3986 standards. Some characters are not considered
safe for URL
safe for URL
3
use.
3
For more information, see section 2.2 URL Character Encoding Issues in RFC 1738.