enviPath Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Rule ======

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

==== GET ====

^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
|/rule    | //optional parameter "delimiter" for text/csv only, default value: ","//      | text/html        |List of all rules of all packages that the user has permission to read. | 200 - OK|
| ::: | ::: | application/json | ::: | 500 - Internal Server Error|
| ::: | ::: | text/plain | ::: | :::|
| ::: | ::: | text/csv | ::: | :::|
|/package/<id>/rule    | //optional parameter "delimiter" for text/csv only, default value: ","//      | text/html        |List of all rules of the package given by the URI. | 200 - OK|
| ::: | ::: | application/json | ::: | 401 - Unauthorized|
| ::: | ::: | text/plain | ::: | 500 - Internal Server Error|
| ::: | ::: | text/csv | ::: | :::|
|/package/<id>/rule/<id>    | //optional parameter "delimiter" for text/csv only, default value: ","//      | text/html        |The rule identified by the URI. | 200 - OK|
| ::: | ::: | application/json | ::: | 401 - Unauthorized|
| ::: | ::: | text/plain | ::: | 404 - Not Found|
| ::: | ::: | text/csv | ::: | 500 - Internal Server Error|

==== POST ====

^ URI              ^ Parameter            ^ Accept Types          ^ Result ^ Status Codes ^
|/rule    | //smirks//      | :::   |Create a new Rule in the default package. The redirect points to the URI of the new Rule. If the hidden method APPLYRULES is used all rules from the default package are applied to the compound given by smiles. | 303 - See Other|
| ::: | //name// | ::: | ::: | 500 - Internal Server Error|
| ::: | //description// | ::: | ::: | :::|
| ::: | //productFilterSmarts// | ::: | ::: | :::|
| ::: | //reactantFilterSmarts// | ::: | ::: | :::|
| ::: | //likelihood// | ::: | ::: | :::|
| ::: | //hiddenMethod = APPLYRULES// | ::: | ::: | :::|
| ::: | //compound - compound smiles// | ::: | ::: | :::|
| ::: | //smirks// | ::: | ::: | :::|
| ::: | //name// | ::: | ::: | :::|
| ::: | //description// | ::: | ::: | :::|
| ::: | //productFilterSmarts// | ::: | ::: | :::|
| ::: | //reactantFilterSmarts// | ::: | ::: | :::|
|/package/<id>/rule    | //likelihood//      | :::   |Create a new Rule in the package given by the URI. The redirect points to the URI of the new Rule. If the hidden method APPLYRULES is used all rules from the package identified by the URI are applied to the compound given by smiles. | 303 - See Other|
| ::: | //subRules// | ::: | ::: | 401 - Unauthorized|
| ::: | //hiddenMethod = APPLYRULES// | ::: | ::: | 500 - Internal Server Error|
| ::: | //compound - compound smiles// | ::: | ::: | :::|
| ::: | //ruleName// | ::: | ::: | :::|
| ::: | //setAsDefaultName// | ::: | ::: | :::|
| ::: | //ruleDescription// | ::: | ::: | :::|
| ::: | //smirks// | ::: | ::: | :::|
| ::: | //ruleProductFilterSmarts// | ::: | ::: | :::|
| ::: | //ruleReactantFilterSmarts// | ::: | ::: | :::|
|package/<id>/rule/<id>    | //hiddenMethod//= APPLYRULES      | :::   |Modify the rule identified by the URI. If the hidden method APPLYRULES is used the rule is applied to the compound given by smiles. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name.| 200 - OK|
| ::: | //compound - compound smiles// | ::: | ::: | 401 - Unauthorized|
| ::: | ::: | ::: | ::: | 404 - Not Found|
| ::: | :::| ::: | ::: | 500 - Internal Server Error|

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


==== PUT ====

Not Implemented.