Difference between revisions of "Compound"
Jump to navigation
Jump to search
(→GET) |
(→POST) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 13: | Line 13: | ||
|/compound | |/compound | ||
| | | | ||
''optional parameter "delimiter" for<br /> | |||
text/csv only, default value: ","'' | |||
|''text/html'' | |''text/html'' | ||
| Line 19: | Line 21: | ||
''text/plain'' | ''text/plain'' | ||
''text/csv'' | ''text/csv'' | ||
|List of all compounds of all packages that the user has permission to read. | |List of all compounds of all packages that the user has permission to read. | ||
|200 - OK | |200 - OK | ||
| Line 26: | Line 28: | ||
|/package/<id>/compound | |/package/<id>/compound | ||
| | | | ||
''optional parameter "delimiter" for<br /> | |||
text/csv only, default value: ","'' | |||
|''text/html'' | |''text/html'' | ||
| Line 32: | Line 36: | ||
''text/plain'' | ''text/plain'' | ||
''text/csv'' | ''text/csv'' | ||
|List of all compounds of the package given by the URI. | |List of all compounds of the package given by the URI. | ||
|200 - OK | |200 - OK | ||
| Line 42: | Line 46: | ||
|/package/<id>/compound/<id> | |/package/<id>/compound/<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'' | ''text/csv'' | ||
---- | ---- | ||
| Line 111: | Line 117: | ||
|''compoundSmiles'' | |''compoundSmiles'' | ||
|rowspan="4"| | |rowspan="4"| | ||
|rowspan="4"|Modify the compound identified by the URI. | |rowspan="4"|Modify the compound identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. | ||
| 200 - OK | | 200 - OK | ||
|- | |- | ||
|''compoundName'' | |''compoundName'' | ||
''setAsDefaultName'' | |||
| 401 - Unauthorized | | 401 - Unauthorized | ||
|- | |- | ||
| Line 123: | Line 130: | ||
| 500 - Internal Server Error | | 500 - Internal Server Error | ||
|} | |} | ||
== DELETE == | == DELETE == | ||
Latest revision as of 14:56, 25 January 2016
REST Operations
GET
| URI | Parameter | Accept Types | Result | Status Codes |
|---|---|---|---|---|
| /compound |
optional parameter "delimiter" for |
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/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/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.