Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<div><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0xfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=1"></p></td></tr></table><h1>Get a List of Manual Measures</h1></div><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Get a list of manual measures</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/manual_measures</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Response Formats</strong></td><td colspan="1" class="confluenceTd">json</td></tr><tr><td class="confluenceTd"><p><strong>Security</strong></p></td><td class="confluenceTd"><p>Requires User role on the project</p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Get all the manual measures on project 'myProject'</td><td class="confluenceTd"><blockquote><p>GET <a href="http://localhost:9000/api/manual_measures?resource=myProject&amp;format=json">http://localhost:9000/api/manual_measures?resource=myProject</a></p></blockquote></td></tr><tr><td class="confluenceTd">Get the manual measure on metric 'business_value' on project 'myProject'</td><td class="confluenceTd"><blockquote><p>GET <a href="http://localhost:9000/api/manual_measures?resource=myProject&amp;metric=business_value&amp;format=json">http://localhost:9000/api/manual_measures?resource=myProject&amp;metric=business_value</a></p></blockquote></td></tr></tbody></table><h3>Response Format</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=javascript|title=JSON" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9SlNPTnxsYW5ndWFnZT1qYXZhc2NyaXB0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>[
  {
    "id":10,
    "metric":"business_value",
    "resource":"java-sonar-runner-simple",
    "val":10.2,
    "desc":"blabla",
    "created_at":"2012-10-10T18:12:23+0200",
    "updated_at":"2012-10-10T18:12:23+0200",
    "login":"admin",
    "username":"Administrator"
  },
  ...
]</pre></td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th class="confluenceTh"><p>Example Value</p></th></tr><tr><td colspan="1" class="confluenceTd"><strong>resource</strong></td><td colspan="1" class="confluenceTd">id or key of the project</td><td colspan="1" class="confluenceTd">Yes</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd"><span>org.codehaus.</span>sonar:sonar</td></tr><tr><td colspan="1" class="confluenceTd"><strong>metric</strong></td><td colspan="1" class="confluenceTd">id of the manual metric</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">business_value</td></tr><tr><td colspan="1" class="confluenceTd"><strong>format</strong></td><td colspan="1" class="confluenceTd"><p>Response format can be set through:</p><ul><li>Parameter format: json</li><li>Or the 'Accept' property in the HTTP header:</li></ul><ul><li style="list-style-type: none;"><ul><li>Accept:application/json</li></ul></li></ul><div>If nothing is set, json is used.</div></td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table><h1>Create a Manual Measure</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Create a manual measure</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/manual_measures</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">POST</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p><span>Requires Project Administrator role on the project</span></p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Create a manual measure on project 'myProject' being logged in as user 'admin/admin':<br /><ul><li>Manual metric: business_value</li><li><p>Value: 5000</p></li><li>Description: myDescription</li></ul></td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;resource=myProject&amp;metric=business_value&amp;val=5000&amp;desc=myDescription&quot; http://localhost:9000/api/manual_measures</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th class="confluenceTh"><p>Example Value</p></th></tr><tr><td class="confluenceTd"><p><strong>resource</strong></p></td><td class="confluenceTd"><p>id or key of the project</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>org.codehaus.sonar:sonar</p></td></tr><tr><td class="confluenceTd"><p><strong>metric</strong></p></td><td class="confluenceTd"><p>Key of the manual metric</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>business_value </p></td></tr><tr><td class="confluenceTd"><p><strong>val</strong></p></td><td class="confluenceTd"><p>Decimal value of the manual measure</p></td><td class="confluenceTd">Yes (or text is set)</td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd">10.0</td></tr><tr><td colspan="1" class="confluenceTd"><strong>text</strong></td><td colspan="1" class="confluenceTd"><span>Text value of the manual measure</span></td><td colspan="1" class="confluenceTd">Yes (or val is set)</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">abc</td></tr><tr><td colspan="1" class="confluenceTd"><strong>desc</strong></td><td colspan="1" class="confluenceTd">Description</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd"><span>myDescription</span></td></tr></tbody></table><h1>Delete a Manual Measure</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Delete a manual measure</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/manual_measures</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">DELETE</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p>Requires Project Administrator role on the project</p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Delete manual measure 'business_value' on project 'myProject'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -X DELETE &quot;http://localhost:9000/api/manual_measures?resource=myProject&amp;metric=business_value&quot;</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th class="confluenceTh"><p>Example Value</p></th></tr><tr><td class="confluenceTd"><p><strong>resource</strong></p></td><td class="confluenceTd"><p>id or key of the project</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>org.codehaus.sonar:sonar</p></td></tr><tr><td class="confluenceTd"><p><strong>metric</strong></p></td><td class="confluenceTd"><p>Key of the manual metric</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td class="confluenceTd"><p>business_value </p></td></tr></tbody></table>