summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTimo Litzbarski <tili2@gmx.de>2015-09-17 16:27:59 +0000
committerTimo Litzbarski <tili2@gmx.de>2015-09-17 16:27:59 +0000
commit55ca46ad754b87991e5cc4c4bc26657b19d37830 (patch)
tree411ed1936d1ae8aa4e96a0b79534eef71bf3a977 /doc
parent08e09c1cac39eb0836ccf11e1ad411832d424022 (diff)
#1232 Api changes: new getMyOverdueTasks, new getOverdueTasksByProject, allow getProjectActivity for user-api
Diffstat (limited to 'doc')
-rw-r--r--doc/api-json-rpc.markdown96
1 files changed, 96 insertions, 0 deletions
diff --git a/doc/api-json-rpc.markdown b/doc/api-json-rpc.markdown
index b11f256b..23371669 100644
--- a/doc/api-json-rpc.markdown
+++ b/doc/api-json-rpc.markdown
@@ -84,6 +84,8 @@ If there is an authentication error, you will receive the HTTP status code `401
- createTask
- updateTask
- getBoard
+- getProjectActivity
+- getMyOverdueTasks
### Custom HTTP header
@@ -2448,6 +2450,55 @@ Response example:
}
```
+### getOverdueTasksByProject
+
+- Purpose: **Get all overdue tasks for a special project**
+- Result on success: **List of tasks**
+- Result on failure: **false**
+
+Request example to fetch all tasks on the board:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "getOverdueTasksByProject",
+ "id": 133280317,
+ "params": {
+ "project_id": 1
+ }
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 133280317,
+ "result": [
+ {
+ "id": "1",
+ "title": "Task #1",
+ "date_due": "1409961789",
+ "project_id": "1",
+ "project_name": "Test",
+ "assignee_username":"admin",
+ "assignee_name": null
+ },
+ {
+ "id": "2",
+ "title": "Test",
+ "date_due": "1409962115",
+ "project_id": "1",
+ "project_name": "Test",
+ "assignee_username":"admin",
+ "assignee_name": null
+ },
+ ...
+ ]
+}
+```
+
### updateTask
- Purpose: **Update a task**
@@ -4366,3 +4417,48 @@ Response example:
}
}
```
+### getMyOverdueTasks
+
+- Purpose: **Get my 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": "getMyOverdueTasks",
+ "id": 133280317
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 133280317,
+ "result": [
+ {
+ "id": "1",
+ "title": "Task #1",
+ "date_due": "1409961789",
+ "project_id": "1",
+ "project_name": "Test",
+ "assignee_username":"admin",
+ "assignee_name": null
+ },
+ {
+ "id": "2",
+ "title": "Test",
+ "date_due": "1409962115",
+ "project_id": "1",
+ "project_name": "Test",
+ "assignee_username":"admin",
+ "assignee_name": null
+ },
+ ...
+ ]
+}
+```