Cisco Cisco Prime Performance Manager 1.7 Developer's Guide
Cisco Prime Performance Manager 1.7 REST API Guide
Table 1 - Report Default Durations
Interval
intervalTypeKey (parameter)
Duration
15 sec
FIFTEEN_SECS
Last 1 hour
30 sec
THIRTY_SECS
Last 1 hour
1 min
ONE_MINUTE
Last 1 hour
5 min
FIVE_MINUTE
Last 6 hours
15 min
1
QUARTER_HOUR
Last 12 hours
Hourly
2
HOUR
Last 24 hours
Daily
DAY
Last 30 days
Weekly
WEEK
Last 6 months
Monthly
MONTH
Last 1 year
5 REST API Components
5.1 Content-Type
The reporting data provided by the REST API is formatted as text (XML, JSON, CSV), image (PNG,
JPEG) or PDF. The data format type chosen for the responses is based on the outputType query string
parameter or the value associated with the incoming HTTP Accept header. If no specific data type is
found in the outputType query string parameter or the HTTP Accept Header is blank or */*, the REST
API defaults the response format and content-type to “text/csv”.
JPEG) or PDF. The data format type chosen for the responses is based on the outputType query string
parameter or the value associated with the incoming HTTP Accept header. If no specific data type is
found in the outputType query string parameter or the HTTP Accept Header is blank or */*, the REST
API defaults the response format and content-type to “text/csv”.
The outputType query string parameter has precedence over the HTTP Accept header. Therefore,
when both the HTTP Accept header and the outputType query string parameter are found in the
request, the response data type is based on the value defined in the outputType parameter.
when both the HTTP Accept header and the outputType query string parameter are found in the
request, the response data type is based on the value defined in the outputType parameter.
5.1.1 HTTP “Accept” Header
The REST API implements the standard HTTP Accept header as specified in the Chapter 14.1 of the RFC
2616, Hypertext Transfer Protocol – HTTP/1.1. When the outputType parameter is not found in the
request, the REST API parses and processes the incoming HTTP Accept header q-factors values to
determine the best acceptable media type for the response.
2616, Hypertext Transfer Protocol – HTTP/1.1. When the outputType parameter is not found in the
request, the REST API parses and processes the incoming HTTP Accept header q-factors values to
determine the best acceptable media type for the response.
Example of using the HTTP Accept header:
1
Node or Group reports are by default rendered as 15 min interval reports. A node report requires either an FQDN
Node or sgmid value to be provided in the FQDN or sgmid parameters in the REST API URL. A group report
uses its own URL path “/groupreports” and the corresponding Group name defined in the FQDN parameter.
uses its own URL path “/groupreports” and the corresponding Group name defined in the FQDN parameter.
2
Network level reports are by default rendered as hourly reports. Network level reports consist of data for the top
node elements. Network level is the default report type when no FQDN=Node or sgmid query string parameter is
provided in the REST API URL.
provided in the REST API URL.