Pathway
REST Operations
GET
| URI | Parameter | Accept Types | Result | Status Codes |
|---|---|---|---|---|
| /pathway | text/html
application/json text/plain |
List of all pathways of all packages that the user has permission to read. | 200 - OK
500 - Internal Server Error | |
| /package/<id>/pathway | text/html
application/json text/plain |
List of all pathways of all the package given by the URI. | 200 - OK
401 - Unauthorized 500 - Internal Server Error | |
| /package/<id>/pathway/<id> | text/html
application/json text/plain |
The pathway identified by the URI. | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error | |
| /package/<id>/pathway/<id>?status | application/json | The status of the pathway identified by the URI. | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error |
POST
| URI | Parameter | Accept Types | Result | Status Codes |
|---|---|---|---|---|
| /pathway | smilesinput
reverse name selectedSetting <settingParams> |
Creates a new predicted pathway in the default package. The redirect points to the URI of the new pathway.
There are 3 ways to select the setting for the pathway: * Do not specify any setting options (uses default setting) * Provide a setting URI with selectedSetting * Provide further setting parameters to create a new setting as defined in the Setting REST API. |
303 - See Other
500 - Internal Server Error | |
| /package/<id>/pathway | smilesinput
reverse name selectedSetting isNew <settingParams> |
Creates a new predicted pathway in the package given by the URI. The redirect points to the URI of the new pathway. | 303 - See Other
401 - Unauthorized 500 - Internal Server Error | |
| /package/<id>/pathway/<id> | pathwayName
pathwayDescription scenario - URI of the scenario |
Modify the compound identified by the URI. | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error | |
| /package/<id>/pathway/<id>/node | nodeAsSmiles
nodeReason nodeName nodeDepth |
Adds a new node to the pathway | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error | |
| /package/<id>/pathway/<id>/node/<id> | nodeName
nodeDescription |
Modify the node identified by the URI. | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error | |
| /package/<id>/pathway/<id>/edge | edgeAsSmirks
edgeReason products educts multistep |
Adds a new edge to the pathway | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error | |
| /package/<id>/pathway/<id>/edge/<id> | edgeName
edgeDescription |
Modify the edge identified by the URI. | 200 - OK
401 - Unauthorized 404 - Not Found 500 - Internal Server Error |
DELETE
| URI | Parameter | Accept Types | Result | Status Codes |
|---|---|---|---|---|
| /pathway | Delete all pathways the user has write access on (does not delete created compounds or reactions). | 303 - See Other
500 - Internal Server Error | ||
| /package/<id>/pathway | Delete all pathways in the package given by the URI. | 303 - See Other
401 - Unauthorized 500 - Internal Server Error | ||
| /package/<id>/pathway/<id> | Delete the pathway identified by the URI. | 303 - See Other | ||
| 401 - Unauthorized | ||||
| 404 - Not Found | ||||
| 500 - Internal Server Error | ||||
| /package/<id>/pathway/<id>/node/<id> | Remove node from pathway. | 303 - See Other
401 - Unauthorized 500 - Internal Server Error | ||
| /package/<id>/pathway/<id>/edge/<id> | Remove edge from pathway. | 303 - See Other
401 - Unauthorized 500 - Internal Server Error |
PUT
Not Implemented.