Cisco Cisco Prime Performance Manager 1.2 開発者ガイド

 

Cisco Prim e Perform ance Manager REST API Guide  

Copyright 2012 Cis co Systems  

- 8 - 

subcategories that form a hierarchical path to various reports in the system. T herefore, you can have 
several categories  within a single path that combined together gives the full path to a specific report. 

T he list of reports for that  category. An empty {category} 
implies the root category that shows all the top report 
categories. 

List all reports subcategories and reports (if any) under the 
“ Availability” category. 

List all reports subcategories and reports (if any) under the 
“ ICMP Ping”  category.   
Note: “ +” (plus-sign) represents a space in the URL. 

 Example: GET  /ppm/rest/reports/{category}../{reportName}?{query String} 

T he REST  API provides data about various sy stem reports. T his resource type is generally known as a 
document. A report document contains the data associated with a given report filtered by any query 
parameters passed in (FQDN, sgmid, start/end date). Prime Performance  Manager reports are unique ly 
identified by a {reportName} and a specific  {category}.  

Notice that {query String} parameters (FQDN,  sgmid, startDate, endDate, …) are use d to filter out the 
reporting data for a given the report document resource. 

A report identified by the 
{reportName} “ICMP Ping 
Availability” which is part of the 
“ ICMP Ping”  {category}.   

T he URL must be encoded accor ding to the Internet URL standards ( RFC 3986). Some characters are not 
considere d safe for URL use. T hese must be properly converted to their encoded counterpart prior to URL 
reque st submission. For safety, always encode the parameter values before you submit the reque st. For 
further information, see to the Internet standards (RFC 3986). 

T he server side of the REST  API always decode s the passed in parameter values accordin g to RFC 3986 
standards. T herefore, the client side must always encode the parameter values usin g the same standards.  

Note: T he “ +”  (plus-sign) represents a space in the URL. If you want to pass a plus (+) character as part 
of a parameter value (for example, 2006-08-25T15:30+0800), you must encode the “ +” to its respective 
URL encode d form “ %2B”. 

T he following table s sho w the RE ST  API request parameters. The REST  API is usin g a subset of the 
HTT P request parameters found in the Prime Performance  Manager we b  base d application. T his allows