Cisco Cisco Prime Performance Manager 1.5 Developer's Guide
Cisco Prime Performance Manager1.5 REST API Guide
The selected media range should be “application/xml”.
5.2 Character Set Encoding
The REST API defaults all the text (XML, JSON, CSV) responses to the UTF-8 charset encoding,
irrespective of the charset value requested by the client on the HTTP header request.
irrespective of the charset value requested by the client on the HTTP header request.
5.3 URI Syntax
The REST API calling URI syntax is defined as follows:
Table 2 – URL Syntax
URL Syntax
For network/node level web reports:
{scheme}://{host}:{port}/ppm/rest/{reportType}/{resource}?{parameters=…}..
{scheme}://{host}:{port}/ppm/rest/{reportType}/{resource}?{parameters=…}..
Table 3 – URL Parts
URL Parts
Sample Value
Description
scheme
http or https
Use https when Prime Performance Manager
SSL is enabled; otherwise, it should be http.
SSL is enabled; otherwise, it should be http.
host
For example: “ppm-clean.cisco.com”
The host name assigned to the Prime
Performance Manager gateway server.
Performance Manager gateway server.
Note: use your own domain/host name.
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.
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.
this value. This is the entry point to the REST
API.
reportType
/dashboards
/reports
/groupreports
/tenantreports
/views
This subpath identifies the report type.
resources
(listing)
/{category}..
A collection resource containing a list of all
report categories, subcategories and/or
corresponding report names URIs.
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.
information (data) itself, which can be filtered
using query string parameters.
parameters
outputType, FQDN, sgmid,
startDate, endDate, durationSelect,
startDate, endDate, durationSelect,
Refer to Query String Parameters