add docu getProjectActivity + getOverdueTasks to API

This commit is contained in:
BlueTeck 2015-02-09 20:10:35 +01:00 committed by Frederic Guillot
parent 3704e33c66
commit 6fbcbfb001
1 changed files with 90 additions and 0 deletions

View File

@ -514,6 +514,30 @@ Response example:
}
```
### getProjectActivity
- Purpose: **Get Activityfeed for Project(s)**
- Parameters:
- **project_ids** (integer array, required)
- **limit** (integer, optional)
- **start** (timestamp, optional)
- **end** (timestamp, optional)
- Result on success: **true**
- Result on failure: **false**
Request example:
```json
{
"jsonrpc": "2.0",
"method": "getProjectActivity",
"id": 942472945,
"params": [
"project_ids": [1,2]
]
}
```
### getMembers
- Purpose: **Get members of a project**
@ -1122,6 +1146,72 @@ Response example:
}
```
### getOverdueTasks
- Purpose: **Get all overdue tasks**
- Result on success: **List of tasks**
- Result on failure: **false**
Request example to fetch all tasks on the board:
```json
{
"jsonrpc": "2.0",
"method": "getOverdueTasks",
"id": 133280317,
}
```
Response example:
```json
{
"jsonrpc": "2.0",
"id": 133280317,
"result": [
{
"id": "1",
"title": "Task #1",
"description": "",
"date_creation": "1409961789",
"color_id": "blue",
"project_id": "1",
"column_id": "2",
"owner_id": "1",
"position": "1",
"is_active": "1",
"date_completed": null,
"score": "0",
"date_due": "0",
"category_id": "0",
"creator_id": "0",
"date_modification": "1409961789",
"swimlane_id": 0
},
{
"id": "2",
"title": "Test",
"description": "",
"date_creation": "1409962115",
"color_id": "green",
"project_id": "1",
"column_id": "2",
"owner_id": "1",
"position": "2",
"is_active": "1",
"date_completed": null,
"score": "0",
"date_due": "0",
"category_id": "0",
"creator_id": "0",
"date_modification": "1409962115",
"swimlane_id": 0
},
...
]
}
```
### updateTask
- Purpose: **Update a task**