Cisco Cisco Prime Performance Manager 1.7 Developer's Guide

Page of 44
 
Cisco Prime Performance Manager 1.7 REST API Guide 
port 
For example: 4440 
HTTP port number assigned to the Prime 
Performance Manager gateway server. Note 
that the same port number can be used when 
Prime Performance Manager is running in 
SSL enabled mode. 
path prefix 
/ppm/rest/ 
All the REST API paths must be prefixed with 
this value. This is the entry point to the REST 
API. 
reportType 
/dashboards  
/reports 
/groupreports 
/views 
/tcas 
This subpath identifies the report type. 
Note: The “/tcas” subpath identifies the TCAs 
(Threshold Crossing Alerts) report. 
resources 
(listing) 
/{category}.. 
A collection resource containing a list of all 
report categories, subcategories and/or 
corresponding report names URIs.   
resources 
(reporting data) 
/{category}../{reportName} 
A document resource containing the report 
information (data) itself, which can be filtered 
using query string parameters. 
parameters 
outputType, FQDN, sgmid,  
startDate, endDate, durationSelect, 
startDate, endDate 
5.4 HTTP Verb 
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   
Table 4 –
 HTTP URL Report Listing Sample 
http://ppm-clean.cisco.com:4440/ppm/rest/{reportType}?outputType=jsonv2 
 
GET /ppm/rest/{reportType}?outputType=jsonv2 
5.5 Resources 
5.5.1 Report Type 
Reports within Prime Performance Manager 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.