This is an old revision of the document!
Table of Contents
Compound
Contents
- REST Operations
º1.1 GET
º1.2 POST
º1.3 DELETE
º1.4 PUT
REST Operations
GET
URI Parameter Accept Types Result Status Codes /compound optional parameter “delimiter” for text/csv only, default value: “,”
text/html application/json
text/plain
text/csv
List of all compounds of all packages that the user has permission to read. 200 - OK 500 - Internal Server Error
/package/<id>/compound optional parameter “delimiter” for text/csv only, default value: “,”
text/html application/json
text/plain
text/csv
List of all compounds of the package given by the URI. 200 - OK 401 - Unauthorized
500 - Internal Server Error
/package/<id>/compound/<id> optional parameter “delimiter” for text/csv only, default value: “,”
text/html application/json
text/plain
text/csv
chemical/x-daylight-smiles
chemical/x-inchi
chemical/x-mdl-molfile
The compound identified by the URI.
Gets the compound smiles, inchi or mol2 file.
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. Set setAsDefaultName to “setAsDefaultName” to use the new alias as default name. 200 - OK compoundName setAsDefaultName
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.