Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel12

This page lists all the available Web Services to be used by any HTTP clients.

Available Web Services

...

Web Service

...

Possible Actions

...

  • authenticate

...

/api/events

Violations and Reviews

events from a a list of global events
  • create an event
  • Domain

    Examples of use cases that can be fulfilled

    Web Service
    Violations
    • get a list of
    • violations on a given resource
    • get all the violations of a project
    • get
    Events
    • the blocker and critical violations of a project
    /api/favouritesviolations
    get the logged in user's Reviews
    • get a list of favouritesreviews
    • create a favouritereview
    • delete a favourite
    Favourites, Filters
    • update a review (add comment, reassign it, etc.)
    /api/manual_measures/api/updatecenter/installed_plugins
    • get the list of all the plugins installed on the Sonar instance
    Update Centerreviews

    Resources and Measures

    metricsprojects
    Domain

    Examples of use cases that can be fulfilled

    Web Service
    Measures, Resources
    • get a list of resources
    • get the measures of a list of metrics on a given resource
    /api/resources
    Manual Measures
    • get a list of manual measures
    • create a manual measure
    • delete a manual measure
    Manual Measures/api/manual_measures
    Time Machine
    • get past measures
    /api/timemachine
    Metrics
    • get a list of metrics
    • create a metric
    • update a metric
    • delete a metric
    Metrics/api/metrics
    • delete a project
    Project Settings
    Sources
    • get a list of lines from source files
    /api/profilessources

    Administration

    propertiesresources resources
  • get the measures of a list of metrics on a given resource
  • Metricsreviewssources a lines from source filestimemachine
    Domain

    Examples of use cases that can be fulfilled

    Web Service
    Quality Profiles
    • get the list of coding rules activated in a quality profile
    • backup a quality profile
    • restore a quality profile
    Quality Profiles/api/profiles
    Rules
    • get a list of rules
    /api/rules
    Properties
    • get a list of properties
    • create a property
    • update a property
    • delete a property
     /api/properties
    User Properties
    • get a list of
    • user properties
    • create a user property
    • update a user property
    • delete a user property
    /api/
    • get a list of reviews
    • create a review
    • update a review (add comment, reassign it, etc.)
    Reviews
    /api/rules
    • get a list of rules
    Quality Profiles
    /api/serveruser_properties
    Project Settings
    • delete a project
    /api/projects
    Security
    • authenticate
    /sessions/login
    Server
    • get the status of the Sonar server
    • upgrade the Sonar database
    • get the system properties, server info (Java, OS), database configuration, JVM statistics and installed plugins
     /api/server
    Update Center
    • get
    • the list of
     
    • all the plugins installed on the Sonar instance
    /api/
    • get past measures
    Time Machine
    /api/user_properties
    • get a list of user properties
    • create a user property
    • update a user property
    • delete a user property
     
    /api/violations
    • get a list of violations on a given resource
    Violations
    updatecenter/installed_plugins
    Events
    • get a list of events from a project
    • get a list of global events
    • create an event
    /api/events
    Favourites
    • get the logged in user's list of favourites
    • create a favourite
    • delete a favourite
    /api/favourites

    Anchor
    simpleExcelSamples
    simpleExcelSamples
    Simple MS Excel Samples

    ...