Compound

From enviPath Wiki
Revision as of 17:52, 20 October 2015 by Wicker (talk | contribs) (Created page with "= REST Operations = == GET == {| class="wikitable" |- !URI !Parameter !Accept Types !Result !Status Codes |- |/compound | |''text/html'' ''application/json'' ''text/plain'...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

REST Operations

GET

URI Parameter Accept Types Result Status Codes
/compound text/html

application/json

text/plain

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

500 - Internal Server Error

/package/<id>/compound text/html

application/json

text/plain

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

401 - Unauthorized

500 - Internal Server Error

/package/<id>/compound/<id> text/html

application/json

text/plain

The compound identified by the URI. 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. 200 - OK
compoundName 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

Not Implemented.