diff options
| author | BlueTeck <tili2@gmx.de> | 2015-02-09 20:10:35 +0100 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2015-02-09 20:48:13 -0500 |
| commit | 6fbcbfb001bbd972f2f958d591f4586d2a2ea468 (patch) | |
| tree | ca13d271057ea68da83370dda809e921be23ea97 /docs | |
| parent | 3704e33c668a63868efec504e3999a9edd123665 (diff) | |
add docu getProjectActivity + getOverdueTasks to API
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-json-rpc.markdown | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown index 6e367c9a..ad3cfaab 100644 --- a/docs/api-json-rpc.markdown +++ b/docs/api-json-rpc.markdown @@ -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** |