diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-04-22 18:49:19 -0400 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-04-22 18:49:19 -0400 |
commit | da1725c225c94bcdffe4dba4c068db8e1e11cbe7 (patch) | |
tree | 8e52c9e16faa88bb5931a6a39cde86219c61b0e9 /doc/api-task-procedures.markdown | |
parent | 756716766cb33da2c25544918574368b51cca26e (diff) |
Added searchTasks API procedure
Diffstat (limited to 'doc/api-task-procedures.markdown')
-rw-r--r-- | doc/api-task-procedures.markdown | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/api-task-procedures.markdown b/doc/api-task-procedures.markdown index d994d662..934b1e09 100644 --- 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" + // ... + } + ] +} +``` |