Cisco Cisco Prime Performance Manager 1.7 Developer's Guide
Cisco Prime Performance Manager 1.7 REST API Guide
5.8 REST Parameter Rules
The following request parameters rules are enforced by the REST API. An error response can be returned
if any of these rules is violated.
if any of these rules is violated.
Only parameters identified in the Query String
Parameter names and values are case sensitive.
Parameter values must be properly formatted.
FQDN and sgmid are mutually exclusive.
sgmid must correspond to a valid node.
An FQDN Node must correspond to a valid node.
startDate, endDate and durationSelect are mutually exclusive.
endDate must be greater than startDate.
durationSelect must be greater than intervalTypeKey.
showAllReports should not contain a value.
showViewReport and showAllReports are mutually exclusive.
Chart parameters (e.g., height, width) are only accepted for report graphs requests
TCA parameters (e.g., thresholdName, kpiName) are only accepted for TCA report requests
5.9 HTTP Request Headers
The following table shows the supported HTTP Request headers.
5.9.1 Accept
Table 42 – Accept HTTP Header
Header Name
Notes
Accept
The requested content-type for the response. This header indicates to the
REST API server the media type of the response that the client expects. When
this header is present, the REST API attempts to respond to the client using
the client’s Accept header preferred media type; unless, that content-type is
not supported.
The REST API implements the Accept header as specified per the Internet
HTTP standards defined in the chapter 14.1 of the RFC 2616, Hypertext
Transfer Protocol – HTTP/1.1.
Note: the “outputType” parameter overrides the Accept header. This
means that if the “outputType” parameter is found in the request, the
Accept header is not processed.
If the Accept header contains multiple media types supported by the REST
API, the corresponding q-factor value is used to determine the best media
type. If there is a match, the REST API chooses the first media range type
found on the Accept header.
The “application/vnd.cisco.ppm+json;v=2” can be used to
select the json version 2 report formats. The JSON version 2 is a simpler data
REST API server the media type of the response that the client expects. When
this header is present, the REST API attempts to respond to the client using
the client’s Accept header preferred media type; unless, that content-type is
not supported.
The REST API implements the Accept header as specified per the Internet
HTTP standards defined in the chapter 14.1 of the RFC 2616, Hypertext
Transfer Protocol – HTTP/1.1.
Note: the “outputType” parameter overrides the Accept header. This
means that if the “outputType” parameter is found in the request, the
Accept header is not processed.
If the Accept header contains multiple media types supported by the REST
API, the corresponding q-factor value is used to determine the best media
type. If there is a match, the REST API chooses the first media range type
found on the Accept header.
The “application/vnd.cisco.ppm+json;v=2” can be used to
select the json version 2 report formats. The JSON version 2 is a simpler data