Cisco Cisco Prime Performance Manager 1.2 開発者ガイド

ページ / 26
 
Cisco Prim e Perform ance Manager REST API Guide  
Copyright 2012 Cis co Systems  
- 14 - 
5.8  REST Parameter Rules 
T he following re que st parameters rules are enforced by the REST  API. 
• 
Only parameters identified in the Reque st Parameters are accepted. 
• 
Parameter names and values are case  sensitive. 
• 
Parameter values must be properly formatted according to their fomat specificifications. 
• 
FQ DN and sgmid are mutually exclusive. 
• 
FQ DN or sgmid must correspond to a valid node found in the Prime Performance 
Manager system. 
• 
startDate endDate  and durationSele ct are mutually exclusive.  
• 
endDate  must be greater than startDate 
• 
durationSele ct must be greater than inte rvalType Ke y
• 
showAllRe ports must not contain a value. 
5.9  HTTP Request Headers 
T he following table has the HTT P Request headers supported. 
5.9.1 Accept 
Table 18 – Accep t HTTP Header 
Header Na me 
Notes  
Accep t 
The requ ested cont ent-ty pe for the resp onse.  This head er indicat es to the REST API 
serv er th e medi a type o f th e respons e ex pected by the client.  When this head er is 
pres ent the REST API will attem pt to respon d to the client using that medi a type; 
unless, that cont ent -type is not suppo rted by the REST API for the req uest ed resou rce.  
Note th at the medi a type  can b e overrid en by th e outputType p aramet er.  
 
Also, note that the REST API cu rrently do es not pars e/p rocess qu ality  facto r “ qvalues” 
scal e (0 to 1) paramet ers th at may be  found on th e accept head er.  As per RFC 2616 
(14.1 Accept), the “ qvalue” is a param eter begin ning with the l etter “ q” that may b e 
pres ent on the accept header to indicate the rel ative p reference fo r a speci fi c medi a 
type.  
 
When multiple media typ es are provided, the REST API will select on e o f them in this 
order:  
 
text/csv  - > appli cation/jso n - > application/xml  
 
Possible suppo rted v alu es are:  
 
text/csv  
application/xml  
application/json  
 
Note:  If no Accept head er is found, or if “*/*”, the respons e will default to the text/ csv 
media t ype.  
Addition al Notes: