REST api

From Lingoport Wiki
Jump to: navigation, search

The Lingoport Dashboard is built on top of SonarQube server and benefits from a number of facilities of that platform, including a REST API. This REST API

1- Go to 'https://dashboard.lingoport.com'. You should see the Dashboard for the public'javademo' dashboard project. There are more projects there, but they are visible only to 'authorized' users. Nothing new, you can see the projects. If you have installed the dashboard on one of your system, you should see the same project. The javademo is the illustrative example for the Globalyzer tutorials, the videos on how to use Globalyzer on the Web site, and the Dashboardso it ties it all together. The Dashboard project also shows LRM issues (resource files, translations, etc.)


Below are some examples of using the Lingoport Dashboard as of today:


2- In your browser, simply go to this URL (will execute an HTTP get):

https://dashboard.lingoport.com/api/resources

This lists the projects in the Dashboard in an XML message which can be used/consumed by any client, including your own Intel Dashboard.


Please note the javademo dashboard identifier: ‘javademo:scan’ !!!


3- List all the violations for the project identified by the key 'javademo:scan': This is the call you want to use most of the time. From the result, you can decide to do whatever you please, aggregate the results, count the type of issue, count all the issues together, etc:

https://dashboard.lingoport.com/api/violations?resource=javademo:scan&depth=-1 


4- If your project source code has been uploaded to the server, as is the case for javademo, then you can see the source around lines of code (typically to give a context for an issue identified in (3) with:

https://dashboard.lingoport.com/api/sources?resource=javademo:scan:src/com/lingoport/demo/java/ExamplePanel.java&from=10&to=20


For the full documentation on what you can access:

http://docs.codehaus.org/display/SONAR/Web+Service+API