Cisco Cisco Prime Performance Manager 1.7 Developer's Guide

 

Cisco Prime Performance Manager 1.7 REST API Guide 

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. 

/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}.  

Encode the URL according to the Internet URL RFC 3986 standards. Some characters are not considered 
safe for URL

3

 use.  

For example, if a query string parameter value should contain the positive sign (+), URL encode the “+” 
character to its corresponding URL escaped sequence “%2B”; otherwise, the “+” will be interpreted as a 
space by the REST API. Other characters such as “{“, “}”, “|”, “\”, “^”, “~”, “[“, “]”, and “`” are unsafe 
because gateways and other transport agents are known to sometimes modify these characters. 

When in doubt about the safety of a character within a query string parameter value, encode the query 
string parameter value before submitting a request. 

The server side of the REST API always decodes the passed in query string parameter values according to 
RFC 3986 standards. Therefore, the client side can safely encode the parameter values using the same 
standards. 

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

The following tables show the REST API request query string parameters. The REST API uses a subset 
of the HTTP request parameters found in the Prime Performance Manager web application. The 
parameter names found in the Prime Performance Manager web application are also found in the REST 
API. This allows the REST API and Prime Performance Manager web application to have consistent 
naming and also allows the same values used in the Prime Performance Manager web application to be 
passed to the REST API. 

Notes: 

  Parameter names/values are case-sensitive. 
  Parameter values should be encoded to escape unsafe HTTP characters.   
  Some parameters are mutually exclusive. 

                                                                 

3

 

For more information, see section 2.2 URL Character Encoding Issues in RFC 1738.