Details
Major Description
Request
GET /api/action_plans/search
Mandatory parameter is :
- 'project' : return action plans from this project key
Response
Both JSON and XML formats are supported. Example :
{
"actionPlans":
[
{
"key": "03f04679-cc2e-4532-9317-05fa8566bb97",
"name": "1.0",
"status": "CLOSED",
"project": "com.sonarsource.it.samples:simple-sample",
"userLogin": "admin",
"deadLine": "2013-06-01T00:00:00+0200",
"totalIssues": 10,
"unresolvedIssues": 0,
"createdAt": "2013-05-29T13:55:00+0200",
"updatedAt": "2013-05-29T13:58:01+0200"
},
{
"key": "32c983ef-3f0c-418e-8afd-11772bcd643c",
"name": "1.2",
"status": "OPEN",
"project": "com.sonarsource.it.samples:simple-sample",
"userLogin": "admin",
"deadLine": "2013-06-06T00:00:00+0200",
"totalIssues": 10,
"unresolvedIssues": 5,
"createdAt": "2013-05-29T13:57:57+0200",
"updatedAt": "2013-06-04T13:37:20+0200"
},
{
"key": "32992445-3829-44dd-9b94-949b43fe6ed7",
"name": "Long term",
"status": "OPEN",
"project": "com.sonarsource.it.samples:simple-sample",
"userLogin": "admin",
"totalIssues": 1,
"unresolvedIssues": 1,
"createdAt": "2013-05-31T09:52:50+0200",
"updatedAt": "2013-06-04T13:39:04+0200"
}
]
}
Request
POST /api/action_plans/create
Mandatory parameters are :
- 'name' : the name of the action plan
- 'project' : the key of the project to link the action plan to
Optional parameter are :
- 'description' : the plain-text description
- 'deadLine' : the due date of the action plan. Format is 'year-month-day', for instance, '2013-12-31'.
Request
POST /api/action_plans/delete
Mandatory parameter is :
- 'key' : the action plan key
Request
POST /api/action_plans/update
Mandatory parameter is :
- 'key' : the action plan key
- 'name' : the name of the action plan
Optional parameter are :
- 'description' : the plain-text description
- 'deadLine' : the due date of the action plan. Format is 'year-month-day', for instance, '2013-12-31'.
Request
POST /api/action_plans/close
Mandatory parameter is :
- 'key' : the action plan key
Request
POST /api/action_plans/open
Mandatory parameter is :
- 'key' : the action plan key
