Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DescriptionGet a list of action plans

URL

/api/action_plans/search

HTTP MethodGET
Response Formatsjson | xml

Security

Requires User role Browse permission on the project

Available sinceVersion 3.6

...

DescriptionCreate an action plan

URL

/api/action_plans/create

HTTP MethodPOST

Security

Requires Project administrator role Administer permission on project

Available sinceVersion 3.6

Examples

Use CaseExample Request

Create an action plan on project org.codehaus.sonar:sonar:

  • Name: Long term
  • Description: Low return on investment
  • Deadline: 2013-12-31

curl -X POST -v -u admin:admin 'http://localhost:9000/api/action_plans/create?name=Long%20term&project=org.codehaus.sonar:sonar&description=Low%20return%20on%20investment&deadLine=2013-12-31'

...

DescriptionDelete an action plan

URL

/api/action_plans/delete

HTTP MethodPOST

Security

Requires Project administrator role Administer permission on project
Available sinceVersion 3.6

Examples

Use CaseExample Request
Delete the '3f19de90-1521-4482-a737-a311758ff513' action plan

curl -X POST -v -u admin:admin 'http://localhost:9000/api/action_plans/delete?key=3f19de90-1521-4482-a737-a311758ff513 '

...

DescriptionUpdate an action plan

URL

/api/action_plans/update

HTTP MethodPOST

Security

Requires Project administrator role Administer permission on project

Available sinceVersion 3.6

Examples

Use CaseExample Request

Update action plan '3f19de90-1521-4482-a737-a311758ff513':

  • New name: Long term 2
  • New description: Low return on investment 2
  • New deadline: 2014-12-31

curl -X POST -v -u admin:admin 'http://localhost:9000/api/action_plans/update?key=3f19de90-1521-4482-a737-a311758ff513&name=Long%20term2&description=Low%20return%20on%20investment2&deadLine=2014-12-31'

...

DescriptionClose an action plan

URL

/api/action_plans/close

HTTP MethodPOST

Security

Requires Project administrator role Administer permission on project

Available sinceVersion 3.6

Examples

Use CaseExample Request

Close action plan '3f19de90-1521-4482-a737-a311758ff513'

curl -X POST -v -u admin:admin 'http://localhost:9000/api/action_plans/close?key=3f19de90-1521-4482-a737-a311758ff513'

...

DescriptionOpen an action plan

URL

/api/action_plans/open

HTTP MethodPOST

Security

Requires Project administrator role Administer permission on project

Available sinceVersion 3.6

Examples

Use CaseExample Request

Open action plan '3f19de90-1521-4482-a737-a311758ff513'

curl -X POST -v -u admin:admin 'http://localhost:9000/api/action_plans/open?key=3f19de90-1521-4482-a737-a311758ff513'

...