Add create/delete documentation for task inventory item [SCI-11306]

scinote-eln · Dec 2, 2024 · 5266ace · 5266ace
1 parent 9433372
commit 5266ace
Showing 1 changed file with 155 additions and 2 deletions.
diff --git a/source/includes/_task_inventory_items.md b/source/includes/_task_inventory_items.md
@@ -200,11 +200,137 @@ This endpoint retrieves a specific inventory item, that is assigned to the speci
 | TASK_ID       | The ID of the task to retrieve inventory item from |
 | ITEM_ID       | The ID of the inventory item to retrieve           |
 
+
+## Create Task Inventory Item
+
+```shell
+curl 'http://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/2/items' \
+  -H 'Authorization: Bearer qwerty123456...' \
+  -d '{
+    "data": {
+      "type": "inventory_items",
+      "attributes": {
+        "item_id": 1
+      }
+    }
+  }'
+```
+
+> The above command returns JSON structured like this:
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "inventory_items",
+      "attributes": {
+        "name": "BOX/1",
+        "archived": false,
+        "created_at": "2021-03-12T19:44:10.627Z",
+        "updated_at": "2022-03-24T13:33:21.291Z",
+        "stock_consumption": "130.0" // present if item contains a stock cell
+      },
+      "relationships": {
+        "inventory_cells": {
+          "data": [
+            {
+              "id": "1",
+              "type": "inventory_cells"
+            },
+            {
+              "id": "2",
+              "type": "inventory_cells"
+            }
+          ]
+        },
+        "inventory": {
+          "data": {
+            "id": "1",
+            "type": "inventories"
+          }
+        }
+      }
+    },
+    {
+      "id": "2",
+      "type": "inventory_items",
+      "attributes": {
+        "name": "BOX/2"
+      },
+      "relationships": {
+        "inventory_cells": {
+          "data": [
+            {
+              "id": "3",
+              "type": "inventory_cells"
+            },
+            {
+              "id": "4",
+              "type": "inventory_cells"
+            }
+          ]
+        },
+        "inventory": {
+          "data": {
+            "id": "1",
+            "type": "inventories"
+          }
+        }
+      }
+    }
+  ],
+  "links": {
+    "self": "http://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/2/items?page%5Bnumber%5D=1&page%5Bsize%5D=10",
+    "first": "http://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/2/items?page%5Bnumber%5D=1&page%5Bsize%5D=10",
+    "prev": null,
+    "next": null,
+    "last": "http://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/2/items?page%5Bnumber%5D=1&page%5Bsize%5D=10"
+  }
+}
+```
+
+This endpoint assign inventory item to the specified task.
+
+### HTTP Request
+
+`GET https://<server-name>/api/v1/teams/<TEAM_ID>/projects/<PROJECT_ID>/experiments/<EXPERIMENT_ID>/tasks/<TASK_ID>/items(?include=<INCLUDES>)`
+
+### URL Parameters
+
+| Parameter     | Description                                                                                        |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| TEAM_ID       | The ID of the team to retrieve project from                                                        |
+| PROJECT_ID    | The ID of the project to retrieve experiment from                                                  |
+| EXPERIMENT_ID | The ID of the experiment to retrieve task from                                                     |
+| TASK_ID       | The ID of the task to assign inventory item                                                        |
+| INCLUDES      | Can set to include `inventory_cells` data                                                          |
+
+> Request body
+
+```json
+{
+  "data": {
+    "type": "inventory_items",
+    "attributes": {
+      "item_id": 1
+    }
+  }
+}
+```
+
+### Inventory item attributes
+
+| Attribute                 | Mandatory | Description                                                                          |
+| ------------------------- | --------- | ------------------------------------------------------------------------------------ |
+| item_id                   | yes       | The ID of the inventory item to assing task                                          |
+
+
 ## Update Task Inventory Item
 
 ```shell
 curl -X POST \
-  https://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/1/protocols/1/steps/1/checklists \
+  https://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/2/items/1 \
   -H 'Authorization: Bearer qwerty123456...' \
   -H 'Content-Type: application/vnd.api+json' \
   -d '{
@@ -327,9 +453,36 @@ This endpoint updates a specific inventory item, that is assigned to the specifi
 }
 ```
 
-### Checklist attributes
+### Inventory item attributes
 
 | Attribute                 | Mandatory | Description                                                                          |
 | ------------------------- | --------- | ------------------------------------------------------------------------------------ |
 | stock_consumption         | yes       | Stock consumption to be set on the item.                                             |
 | stock_consumption_comment | no        | Stock consumption comment to be set on the item. This will be recorded in the ledger |
+
+## Delete Task Inventory Item
+
+```shell
+curl -X DELETE \
+  https://<server-name>/api/v1/teams/1/projects/1/experiments/1/tasks/2/items/1 \
+  -H "Authorization: Bearer qwerty123456..."
+```
+
+> The above command returns empty body with status code 200
+
+This endpoint deletes specific assigned inventory item from the task.
+
+### HTTP Request
+
+`DELETE https://<server-name>/api/v1/teams/<TEAM_ID>/projects/<PROJECT_ID>/experiments/<EXPERIMENT_ID>/tasks/<TASK_ID>/items/<ID>`
+
+### URL Parameters
+
+| Parameter     | Description                                                                                        |
+| ------------- | -------------------------------------------------------------------------------------------------- |
+| TEAM_ID       | The ID of the team to retrieve project from                                                        |
+| PROJECT_ID    | The ID of the project to retrieve experiment from                                                  |
+| EXPERIMENT_ID | The ID of the experiment to retrieve task from                                                     |
+| TASK_ID       | The ID of the task to assigned inventory item                                                      |
+| ID            | The ID of the inventory item to assigned task                                                      |
+