User Tools

Site Tools


compound

Table of Contents

Compound

REST Operations

GET

URI Parameter Accept Types Result Status Codes
/compound optional parameter “delimiter” for text/csv only, default value: “,” text/html List of all compounds of all packages that the user has permission to read 200 - OK
application/json 500 - Internal Server Error
text/plain 200 - OK
text/csv 401 - Unauthorised
text/html 500 - Internal Server Error
/package/<id>/compound optional parameter “delimiter” for text/csv only, default value: “,” text/plainList of all compounds of the package given by the URI200 - OK
text/csv401 - Unauthorized
text/html500 - Internal Server Error
application/json
text/plain/ The compound identified by the URI 200-OK
text/csv/ 401 - Unauthorized
/package/<id>/compound/<id> optional parameter “delimiter” for text/csv only, default value: “,”chemical/x-daylight-smiles Gets the compound smiles, inchi or mol2 file 404 - Not Found
chemical/x-inchi500 - Internal Server Error
chemical/x-mdl-molfile

POST

URI Parameter Accept Types Result Status Codes
/compoundcompoundSmilesCreate a new Compound in the default package. The redirect points to the URI of the new Compound. 303 - See Other
compoundName500 - Internal Server Error
compoundDescription
/package/<id>/compoundcompoundNameCreate a new Compound in the package given by the URI. The redirect points to the URI of the new Compound. 401 - Unauthorized
compoundDescription500 - Internal Server Error
compoundSmiles 200 - OK
/package/<id>/compound/<id>setAsDefaultNameModify the compound identified by the URI. Set to “setAsDefaultName” to use the new alias as default name. 401 - Unauthorized
compoundDescription404 - Not Found

DELETE

URI Parameter Accept Types Result Status Codes
/compoundDelete all compounds the user has write access on303 - See Other
500 - Internal Server Error
303 - See Other
/package/<id>/compoundDelete all compounds in the package given by the URI401- 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
compound.txt · Last modified: 2023/12/20 16:36 by shankar