Cisco Cisco Prime Performance Manager 1.6 User Manuals

Table of Contents

• Purpose

  3
• Assumptions

  3
• 2.1 Audience

  3
• 2.2 HTTP Version

  4
• 2.3 SSL and HTTP

  4
• 2.4 Read Only API

  4
• 2.5 Versioning

  4
• Prime Performance Manager REST API Installation

  4
• Reports Default Time Durations

  4
• REST API Components

  5
• 5.1 Content-Type

  5
• 5.1.1 HTTP “Accept” Header

  5
• 5.2 Character Set Encoding

  6
• 5.3 URI Syntax

  6
• 5.4 HTTP Verb

  7
• 5.5 Resources

  7
• 5.5.1 Report Type

  7
• 5.5.2 Report Listing (Report Categories and Report Names)

  8
• 5.5.3 Reports

  8
• 5.6 URL Encoding

  9
• 5.7 Query String Parameters

  9
• 5.7.1 FQDN

  10
• 5.7.2 sgmid

  10
• 5.7.3 startDate

  11
• 5.7.4 endDate

  12
• 5.7.5 durationSelect

  13
• 5.7.6 intervalTypeKey

  13
• 5.7.7 showSeconds

  14
• 5.7.8 pageIndex

  15
• 5.7.9 maxPageSize

  15
• 5.7.10 outputType

  15
• 5.7.11 csvHeader

  16
• 5.7.12 includeDataTypes

  16
• 5.7.13 reportObjectFilter

  16
• 5.7.14 filterAlgorithm

  18
• 5.7.15 deviceTimeZone

  18
• 5.7.16 showAllReports

  19
• 5.7.17 sortDirection

  19
• 5.7.18 sortedColumId

  20
• 5.7.19 precisionDigitLimit

  20
• 5.7.20 summary

  21
• 5.7.21 seriesLimit

  21
• 5.7.22 showViewReport

  21
• 5.7.23 chartType

  22
• 5.7.24 width

  22
• 5.7.25 height

  22
• 5.7.26 showLegend

  23
• 5.7.27 showTitle

  23
• 5.7.28 chartName

  23
• 5.7.29 thresholdName

  24
• 5.7.30 kpiName

  24
• 5.7.31 kpiReportName

  24
• 5.7.32 tcaType

  25
• 5.7.33 tcaTenant

  25
• 5.8 REST Parameter Rules

  25
• 5.9 HTTP Request Headers

  26
• 5.9.1 Accept

  26
• 5.9.2 Authorization

  27
• 5.10 HTTP Response Headers

  27
• 5.11 HTTP Status Code

  28
• 5.12 Error Responses

  29
• REST APIs

  30
• 6.1 GET Report Listing

  31
• 6.2 Report Listing Samples

  31
• 6.2.1 CSV

  31
• 6.2.2 JSONv2

  32
• 6.2.3 JSON

  32
• 6.2.4 XML

  33
• 6.3 GET Report

  35
• 6.4 Report Samples

  35
• 6.4.1 CSV

  35
• 6.4.2 JSONv2

  36
• 6.4.3 JSON

  38
• 6.4.4 XML

  39
• Pagination

  40
• References

  41
• Glossary

  41