Crucible 2.7 : Review Service - Miscellaneous

The content on this page is deprecated. Please see the separate documentation space for developer reference material about FishEye and Crucible.

On this page:

Miscellaneous

Get Metrics


URL:

GET /reviews-v1/metrics/<version>

Description:
Get the replies to an existing comment.
Status Code:
200 (OK) on success.

Example XML Return Data:

<?xml version="1.0"?>
<metrics>
	<metricsData>
		<configVersion>1</configVersion>
		<defaultValue>
			<name>Minor</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">0</value>
		</defaultValue>
		<label>Ranking</label>
		<name>rank</name>
		<type>INTEGER</type>
		<values>
			<name>Major</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">1</value>
		</values>
		<values>
			<name>Minor</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">0</value>
		</values>
	</metricsData>
	<metricsData>
		<configVersion>1</configVersion>
		<defaultValue>
			<name>Improvement desirable</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">5</value>
		</defaultValue>
		<label>Classification</label>
		<name>classification</name>
		<type>INTEGER</type>
		<values>
			<name>Missing</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">1</value>
		</values>
		<values>
			<name>Extra (superfluous)</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">2</value>
		</values>
		<values>
			<name>Ambiguous</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">3</value>
		</values>
		<values>
			<name>Inconsistent</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">4</value>
		</values>
		<values>
			<name>Improvement desirable</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">5</value>
		</values>
		<values>
			<name>Not conforming to standards</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">6</value>
		</values>
		<values>
			<name>Risk-prone</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">7</value>
		</values>
		<values>
			<name>Factually incorrect</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">8</value>
		</values>
		<values>
			<name>Not implementable</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">9</value>
		</values>
		<values>
			<name>Editorial</name>
			<value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">10</value>
		</values>
	</metricsData>
</metrics>

Example JSON Return Data:

{"metrics":{"metricsData": [
	{"configVersion":1,
	"defaultValue":{"name":"Minor","value":0},
	"label":"Ranking",
	"name":"rank",
	"type":"INTEGER",
	"values":[
		{"name":"Major","value":1},
		{"name":"Minor","value":0}
	]},
	{"configVersion":1,
	"defaultValue":{"name":"Improvement desirable","value":5},
	"label":"Classification",
	"name":"classification",
	"type":"INTEGER",
	"values":[
		{"name":"Missing","value":1},
		{"name":"Extra (superfluous)","value":2},
		{"name":"Ambiguous","value":3},
		{"name":"Inconsistent","value":4},
		{"name":"Improvement desirable","value":5},
		{"name":"Not conforming to standards","value":6},
		{"name":"Risk-prone","value":7},
		{"name":"Factually incorrect","value":8},
		{"name":"Not implementable","value":9},
		{"name":"Editorial","value":10}
	]}
]}}