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

application/json

text/plain

text/csv

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

500 - Internal Server Error

/package/<id>/reaction

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

text/html

application/json

text/plain

text/csv

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

401 - Unauthorized

500 - Internal Server Error

/package/<id>/reaction/<id>

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

text/html

application/json

text/plain

text/csv


chemical/x-daylight-smiles

The reaction identified by the URI.





Gets the reaction SMIRKS.

200 - OK

401 - Unauthorized

404 - Not Found

500 - Internal Server Error

/package/<id>/reaction/<id>/lhs

/package/<id>/reaction/<id>/rhs

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

text/html

application/json

text/plain

text/csv

A list of all educts (lhs) or products (rhs) of a given reaction. 200 - OK

401 - Unauthorized

404 - Not Found

500 - Internal Server Error

/package/<id>/reaction/<id>/lhs/<id>

/package/<id>/reaction/<id>/rhs/<id>

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

text/html

application/json

text/plain

text/csv

A specific educt (lhs) or product (rhs) of a given reaction 200 - OK

401 - Unauthorized

404 - Not Found

500 - Internal Server Error

POST

URI Parameter Accept Types Result Status Codes
/reaction reactionName

reactionDescription

smirks

educt

product

rule

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

500 - Internal Server Error

/package/<id>/reaction reactionName

reactionDescription

smirks

educt

product

rule

Create a new Reaction 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>/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

setAsDefaultName

401 - Unauthorized
scenario 404 - Not Found
ruleUri 500 - Internal Server Error

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

401 - Unauthorized

500 - Internal Server Error

/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.