Differences

This shows you the differences between two versions of the page.

--- compound [2023/12/20 08:21] – shankar
+++ compound [2024/03/19 13:23] (current) – shankar
@@ Line 7: / Line 7: @@
 ==== GET ====
-{{:screenshot_2023-12-13_at_15.28.03.png?nolink|}}
+^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
+|/compound    | optional parameter "delimiter" for text/csv only, default value: ","          | text/html        |List of all compounds of all packages that the user has permission to read | 200 - OK|
+| ::: | ::: | application/json | ::: | 500 - Internal Server Error|
+| ::: | ::: | text/plain | :::|200 - OK |
+| ::: | ::: | text/csv |::: | 401 - Unauthorised |
+| ::: | ::: | text/html |::: |500 - Internal Server Error|
+|/package/<id>/compound    |optional parameter "delimiter" for text/csv only, default value: "," |text/plain|List of all compounds of the package given by the URI|200 - OK|
+| ::: | ::: |text/csv|:::|401 - Unauthorized|
+| ::: | ::: |text/html|:::|500 - Internal Server Error|
+| ::: | ::: |application/json|:::|:::|
+| ::: | ::: |text/plain/| The compound identified by the URI | 200-OK |
+|:::|:::| text/csv/ |::: | 401 - Unauthorized |
+|/package/<id>/compound/<id> |optional parameter "delimiter" for text/csv only, default value: ","|chemical/x-daylight-smiles| Gets the compound smiles, inchi or mol2 file |404 - Not Found|
+|:::|:::|chemical/x-inchi|:::|500 - Internal Server Error|
+|:::|:::|chemical/x-mdl-molfile|::: |:::|
 ===== POST =====
-{{:screenshot_2023-12-13_at_15.44.39.png?nolink|}}
+^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
+|/compound|//compoundSmiles//|:::|Create a new Compound in the default package. The redirect points to the URI of the new Compound.| 303 - See Other|
+|:::|//compoundName//|::: |:::|500 - Internal Server Error |
+|:::|//compoundDescription//|:::|:::|
+|/package/<id>/compound|//compoundName//|:::|Create a new Compound in the package given by the URI. The redirect points to the URI of the new Compound.| 401 - Unauthorized |
+|:::|//compoundDescription//|:::|:::|500 - Internal Server Error |
+|:::|//compoundSmiles//|:::|:::| 200 - OK |
+|/package/<id>/compound/<id>|//setAsDefaultName//|:::|Modify the compound identified by the URI. Set  to "setAsDefaultName" to use the new alias as default name.| 401 - Unauthorized|
+|:::|//compoundDescription//|:::|:::|404 - Not Found|
 ===== DELETE =====
-{{:screenshot_2023-12-13_at_16.00.47.png?nolink|}}
+^ URI              ^ Parameter Accept Types          ^ Result ^ Status Codes ^
+|/compound|:::|Delete all compounds the user has write access on|303 - See Other |
+|:::|:::|:::|500 - Internal Server Error |
+|:::|:::|:::|303 - See Other |
+|/package/<id>/compound|:::|Delete all compounds in the package given by the URI|401- Unauthorized|
+|:::|:::|:::|500 - Internal Server Error|
+|/package/<id>/compound/<id>|:::|Delete the compound identified by the URI.|303 - See Other|
+|:::|:::|:::| 401 - Unauthorized |
+|:::|:::|:::| 404 - Not Found |
+|:::|:::|:::|500 - Internal Server Error|
+===== PUT =====
+Not Implemented.