Added searchTasks API procedure

2016-04-22 18:49:19 -04:00
parent 756716766c
commit da1725c225
5 changed files with 88 additions and 0 deletions
--- a/doc/api-task-procedures.markdown
+++ b/doc/api-task-procedures.markdown
@@ -636,3 +636,62 @@ Response example:
    "result": 6
 }
 ```
+
+## searchTasks
+
+- Purpose: **Find tasks by using the search engine**
+- Parameters:
+    - **project_id** (integer, required)
+    - **query** (string, required)
+- Result on success: **list of tasks**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "searchTasks",
+    "id": 1468511716,
+    "params": {
+        "project_id": 2,
+        "query": "assignee:nobody"
+    }
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 1468511716,
+    "result": [
+        {
+            "nb_comments": "0",
+            "nb_files": "0",
+            "nb_subtasks": "0",
+            "nb_completed_subtasks": "0",
+            "nb_links": "0",
+            "nb_external_links": "0",
+            "is_milestone": null,
+            "id": "3",
+            "reference": "",
+            "title": "T3",
+            "description": "",
+            "date_creation": "1461365164",
+            "date_modification": "1461365164",
+            "date_completed": null,
+            "date_started": null,
+            "date_due": "0",
+            "color_id": "yellow",
+            "project_id": "2",
+            "column_id": "5",
+            "swimlane_id": "0",
+            "owner_id": "0",
+            "creator_id": "0"
+            // ...
+         }
+    ]
+}
+```