enviPath Wiki

User Tools

Site Tools

Trace: • compounds • compound
compound

Differences

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

Link to this comparison view

Next revision		Previous revision
compound [2023/12/13 12:58] – created shankarcompound [2024/03/19 13:23] (current) – shankar
Line 1: Line 1:
 ====== Compound ====== ====== Compound ======
  
- +  
-==== Contents ==== +
- +
- +
-  *  REST Operations +
-     º1.1 GET  +
-     º1.2 POST  +
-     º1.3 DELETE  +
-     º1.4 PUT+
                  
 ===== REST Operations ===== ===== REST Operations =====
Line 15: Line 7:
 ==== GET ==== ==== GET ====
  
 +^ 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|::: |:::|
  
-URI Parameter Accept Types Result Status Codes 
-/compound  
-optional parameter "delimiter" for 
-text/csv only, default value: "," 
  
-text/html +===== POST ===== 
-application/json+^ 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|
  
-text/plain+===== DELETE =====
  
-text/csv +^ URI              ^ Parameter Accept Types          ^ Result ^ Status Codes ^  
- +|/compound|:::|Delete all compounds the user has write access on|303 - See Other | 
-List of all compounds of all packages that the user has permission to read. 200 - OK +|:::|:::|:::|500 - Internal Server Error | 
-500 - Internal Server Error +|:::|:::|:::|303 - See Other | 
- +|/package/<id>/compound|:::|Delete all compounds in the package given by the URI|401- Unauthorized| 
-/package/<id>/compound  +|:::|:::|:::|500 - Internal Server Error| 
-optional parameter "delimiter" for +|/package/<id>/compound/<id>|:::|Delete the compound identified by the URI.|303 - See Other| 
-text/csv only, default value: "," +|:::|:::|:::| 401 - Unauthorized | 
- +|:::|:::|:::| 404 - Not Found | 
-text/html +|:::|:::|:::|500 - Internal Server Error|
-application/json +
- +
-text/plain +
- +
-text/csv +
- +
-List of all compounds of the package given by the URI. 200 - OK +
-401 - Unauthorized +
- +
-500 - Internal Server Error +
- +
-/package/<id>/compound/<id>  +
-optional parameter "delimiter" for +
-text/csv only, default value: "," +
- +
-text/html +
-application/json +
- +
-text/plain +
- +
-text/csv +
- +
-chemical/x-daylight-smiles +
- +
-chemical/x-inchi +
- +
-chemical/x-mdl-molfile +
- +
-The compound identified by the URI. +
- +
- +
-Gets the compound smiles, inchi or mol2 file. +
- +
-200 - OK +
-401 - Unauthorized +
- +
-404 - Not Found +
- +
-500 - Internal Server Error +
- +
-POST +
- +
-URI Parameter Accept Types Result Status Codes +
-/compound compoundSmiles +
-compoundName +
- +
-compoundDescription +
- +
-Create a new Compound in the default package. The redirect points to the URI of the new Compound. 303 - See Other +
-500 - Internal Server Error +
- +
-/package/<id>/compound compoundSmiles +
-compoundName +
- +
-compoundDescription +
- +
-Create a new Compound in the package given by the URI. The redirect points to the URI of the new Compound. 303 - See Other +
-401 - Unauthorized +
- +
-500 - Internal Server Error +
- +
-/package/<id>/compound/<id> compoundSmiles Modify the compound identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. 200 - OK +
-compoundName +
-setAsDefaultName +
- +
-401 - Unauthorized +
-compoundDescription 404 - Not Found +
-scenario - URI of the scenario 500 - Internal Server Error +
-DELETE +
- +
-URI Parameter Accept Types Result Status Codes +
-/compound Delete all compounds the user has write access on. 303 - See Other +
-500 - Internal Server Error +
- +
-/package/<id>/compound Delete all compounds in the package given by the URI. 303 - See Other +
-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+
  
 +===== PUT =====
 Not Implemented. Not Implemented.
- 
compound.1702472336.txt.gz · Last modified: 2023/12/13 12:58 by shankar