===== Reaction =====


From enviPath Wiki
Jump to navigation Jump to search

     
===== REST Operations =====

==== GET ====

^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
|/reaction    | 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 | ::: | :::|
| ::: | ::: | text/csv | ::: | :::|
| ::: | ::: | text/html | ::: | :::|
| ::: | ::: | application/json | ::: | :::|
|/package/<id>/reaction   | optional parameter "delimiter" for text/csv only, default value: ","         | text/plain        |List of all reactions of the package given by the URI.| 200 - OK|
| ::: | ::: | text/csv | ::: | 401 - Unauthorized|
| ::: | ::: | text/html | ::: | 500 - Internal Server Error|
| ::: | ::: | application/json | ::: |:::|
|/package/<id>/reaction/<id>  | optional parameter "delimiter" for text/csv only, default value: ","         | text/plain        |The reaction identified by the URI.| 200 - OK|
| ::: | ::: | text/csv | ::: | 401 - Unauthorized|
| ::: | ::: | :::| ::: | 404 - Not Found|
| ::: | ::: | :::| ::: | 500 - Internal Server Error|
|  |  | chemical/x-daylight-smiles| Gets the reaction SMIRKS. | |
|  |  | text/html|::: | |
|/package/<id>/reaction/<id>/lhs  | optional parameter "delimiter" for text/csv only, default value: ","         | application/json        |A list of all educts (lhs) or products (rhs) of a given reaction.| 200 - OK|
| /package/<id>/reaction/<id>/rhs|:::| text/plain|::: |401 - Unauthorized|
|:::|:::| text/csv|::: |404 - Not Found|
|:::|:::| text/html|::: |500 - Internal Server Error|
|/package/<id>/reaction/<id>/lhs/<id> | optional parameter "delimiter" for text/csv only, default value: ","| text/html|A specific educt (lhs) or product (rhs) of a given reaction| 200 - OK|
|/package/<id>/reaction/<id>/rhs/<id>|:::|application/json|::: |401 - Unauthorized|
|:::|:::| text/plain|::: |404 - Not Found|
|:::|:::| text/csv|::: |500 - Internal Server Error|


==== POST ====
^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
|/reaction    |reactionName|         |Create a new reaction in the default package. The redirect points to the URI of the new Compound. Either the SMIRKS, or the educt and product need to be given. | 303 - See Other|
| ::: | reactionDescription |:::| ::: | 500 - Internal Server Error|
| ::: |smirks |:::| ::: | :::|
| ::: |educt |:::| ::: | :::|
| ::: |product |:::| ::: | :::|
| ::: |rule |:::| ::: | :::|
|/package/<id>/reaction   |reactionName|         |Create a new Reaction in the package given by the URI. The redirect points to the URI of the new Compound. | 303 - See Other|
| ::: | reactionDescription |:::| ::: | 401 - Unauthorized|
| ::: |smirks |:::| ::: | 500 - Internal Server Error|
| ::: |educt |:::| ::: | :::|
| ::: |product |:::| ::: | :::|
| ::: |rule |:::| ::: | :::|
|/package/<id>/reaction/<id>   |reactionDescription|         |Modify the reaction identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. | 200 - OK|
| ::: | reactionName|:::| ::: | 401 - Unauthorized|
| ::: |setAsDefaultName |:::| ::: | 404 - Not Found|
| ::: |scenario |:::| ::: | 500 - Internal Server Error|
| ::: |ruleUri |:::| ::: | :::|


==== DELETE ====

^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
|/reaction |:::|:::| Delete all reactions the user has write access on. | 303 - See Other|
| ::: |::: |:::| ::: | 500 - Internal Server Error|
| /package/<id>/reaction |::: |:::| Delete all reactions in the package given by the URI | 303 - See Other|
| ::: |::: |:::| ::: | 500 - Internal Server Error|
| ::: |::: |:::| ::: | 401 - Unauthorized|
| /package/<id>/reaction/<id> |::: |:::| Delete the reaction identified by the URI. | 303 - See Other|
| ::: |::: |:::| ::: | 401 - Unauthorized|
| ::: |::: |:::| ::: | 404 - Not Found|
| ::: |::: |:::| ::: | 500 - Internal Server Error|




==== PUT ====

Not Implemented.