From 3d34681610854474cb9dbdd93886dbcf0e208a99 Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Sun, 26 Jun 2016 14:33:53 -0400
Subject: Added new API calls for external task links

---
 doc/api-internal-task-link-procedures.markdown | 187 +++++++++++++++++++++++++
 1 file changed, 187 insertions(+)
 create mode 100644 doc/api-internal-task-link-procedures.markdown

(limited to 'doc/api-internal-task-link-procedures.markdown')

diff --git a/doc/api-internal-task-link-procedures.markdown b/doc/api-internal-task-link-procedures.markdown
new file mode 100644
index 00000000..859228de
--- /dev/null
+++ b/doc/api-internal-task-link-procedures.markdown
@@ -0,0 +1,187 @@
+Internal Task Links API Procedures
+==================================
+
+## createTaskLink
+
+- Purpose: **Create a link between two tasks**
+- Parameters:
+    - **task_id** (integer, required)
+    - **opposite_task_id** (integer, required)
+    - **link_id** (integer, required)
+- Result on success: **task_link_id**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "createTaskLink",
+    "id": 509742912,
+    "params": [
+        2,
+        3,
+        1
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 509742912,
+    "result": 1
+}
+```
+
+## updateTaskLink
+
+- Purpose: **Update task link**
+- Parameters:
+    - **task_link_id** (integer, required)
+    - **task_id** (integer, required)
+    - **opposite_task_id** (integer, required)
+    - **link_id** (integer, required)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "updateTaskLink",
+    "id": 669037109,
+    "params": [
+        1,
+        2,
+        4,
+        2
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 669037109,
+    "result": true
+}
+```
+
+## getTaskLinkById
+
+- Purpose: **Get a task link**
+- Parameters:
+    - **task_link_id** (integer, required)
+- Result on success: **task link properties**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getTaskLinkById",
+    "id": 809885202,
+    "params": [
+        1
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 809885202,
+    "result": {
+        "id": "1",
+        "link_id": "1",
+        "task_id": "2",
+        "opposite_task_id": "3"
+    }
+}
+```
+
+## getAllTaskLinks
+
+- Purpose: **Get all links related to a task**
+- Parameters:
+    - **task_id** (integer, required)
+- Result on success: **list of task link**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getAllTaskLinks",
+    "id": 810848359,
+    "params": [
+        2
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 810848359,
+    "result": [
+        {
+            "id": "1",
+            "task_id": "3",
+            "label": "relates to",
+            "title": "B",
+            "is_active": "1",
+            "project_id": "1",
+            "task_time_spent": "0",
+            "task_time_estimated": "0",
+            "task_assignee_id": "0",
+            "task_assignee_username": null,
+            "task_assignee_name": null,
+            "column_title": "Backlog"
+        }
+    ]
+}
+```
+
+## removeTaskLink
+
+- Purpose: **Remove a link between two tasks**
+- Parameters:
+    - **task_link_id** (integer, required)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "removeTaskLink",
+    "id": 473028226,
+    "params": [
+        1
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 473028226,
+    "result": true
+}
+```
-- 
cgit v1.2.3


From 7e0e7eba6df951d1795bdd73cd49479ff2cab860 Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Sun, 26 Jun 2016 16:54:57 -0400
Subject: Fixed some typo in documentation

---
 doc/api-external-task-link-procedures.markdown | 4 ++--
 doc/api-internal-task-link-procedures.markdown | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

(limited to 'doc/api-internal-task-link-procedures.markdown')

diff --git a/doc/api-external-task-link-procedures.markdown b/doc/api-external-task-link-procedures.markdown
index 2858be86..85f67b60 100644
--- a/doc/api-external-task-link-procedures.markdown
+++ b/doc/api-external-task-link-procedures.markdown
@@ -1,5 +1,5 @@
-Internal Task Links API Procedures
-==================================
+External Task Link API Procedures
+=================================
 
 ## getExternalTaskLinkTypes
 
diff --git a/doc/api-internal-task-link-procedures.markdown b/doc/api-internal-task-link-procedures.markdown
index 859228de..eca0d886 100644
--- a/doc/api-internal-task-link-procedures.markdown
+++ b/doc/api-internal-task-link-procedures.markdown
@@ -1,5 +1,5 @@
-Internal Task Links API Procedures
-==================================
+Internal Task Link API Procedures
+=================================
 
 ## createTaskLink
 
-- 
cgit v1.2.3