Difference between revisions of "Rule"

From enviPath Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:
|/rule
|/rule
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


Line 19: Line 21:
''text/plain''
''text/plain''


''text/csv'' (optional parameter "delimiter", default value: ",")
''text/csv''
|List of all rules of all packages that the user has permission to read.
|List of all rules of all packages that the user has permission to read.
|200 - OK
|200 - OK
Line 26: Line 28:
|/package/<id>/rule
|/package/<id>/rule
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


Line 32: Line 36:
''text/plain''
''text/plain''


''text/csv'' (optional parameter "delimiter", default value: ",")
''text/csv''
|List of all rules of the package given by the URI.
|List of all rules of the package given by the URI.
|200 - OK
|200 - OK
Line 42: Line 46:
|/package/<id>/rule/<id>
|/package/<id>/rule/<id>
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


Line 48: Line 54:
''text/plain''
''text/plain''


''text/csv'' (optional parameter "delimiter", default value: ",")
''text/csv''
|The rule identified by the URI.
|The rule identified by the URI.
|200 - OK
|200 - OK
Line 124: Line 130:
|rowspan="6"|/package/<id>/rule/<id>
|rowspan="6"|/package/<id>/rule/<id>
|''ruleName''
|''ruleName''
''setAsDefaultName''
|rowspan="6"|
|rowspan="6"|
|rowspan="6"|Modify the rule identified by the URI. If the hidden method APPLYRULES is used the rule is applied to the compound given by smiles.  
|rowspan="6"|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
| 200 - OK
|-
|-
Line 148: Line 155:
|
|
|}
|}


== DELETE ==  
== DELETE ==  

Latest revision as of 15:04, 25 January 2016

REST Operations

GET

URI Parameter Accept Types Result Status Codes
/rule

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/plain

text/csv

List of all rules of all packages that the user has permission to read. 200 - OK

500 - Internal Server Error

/package/<id>/rule

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/plain

text/csv

List of all rules of the package given by the URI. 200 - OK

401 - Unauthorized

500 - Internal Server Error

/package/<id>/rule/<id>

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/plain

text/csv

The rule identified by the URI. 200 - OK

401 - Unauthorized

404 - Not Found

500 - Internal Server Error

POST

URI Parameter Accept Types Result Status Codes
/rule smirks

name

description

productFilterSmarts

reactantFilterSmarts

likelihood

subRules


hiddenMethod = APPLYRULES

compound - compound smiles

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

500 - Internal Server Error

/package/<id>/rule smirks

name

description

productFilterSmarts

reactantFilterSmarts

likelihood

subRules


hiddenMethod = APPLYRULES

compound - compound smiles

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

401 - Unauthorized

500 - Internal Server Error

/package/<id>/rule/<id> ruleName

setAsDefaultName

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
ruleDescription 401 - Unauthorized
smirks 404 - Not Found
scenario - URI of the scenario 500 - Internal Server Error
ruleProductFilterSmarts
ruleReactantFilterSmarts

hiddenMethod = APPLYRULES

compound - compound smiles

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

/package/<id>/rule Delete all rules in the package given by the URI. 303 - See Other

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.