Both sides previous revisionPrevious revisionNext revision | Previous revision |
pathway [2024/01/22 08:26] – shankar | pathway [2024/02/01 12:24] (current) – shankar |
---|
|/pathways | optional parameter "delimiter" for text/csv only, default value: "," | text/html | List of all pathways of all packages that the user has permission to read. | 200 - OK| | |/pathways | optional parameter "delimiter" for text/csv only, default value: "," | text/html | List of all pathways of all packages that the user has permission to read. | 200 - OK| |
| ::: | ::: | application/json | ::: | 500 - Internal Server Error| | | ::: | ::: | application/json | ::: | 500 - Internal Server Error| |
| | ::: | ::: |text/plain| ::: | | |
| | ::: | ::: | text/csv | ::: |::: | |
| |/package/<id>/pathway | optional parameter "delimiter" for text/csv only, default value: "," | text/html | List of all pathways of all the package given by the URI. | 200 - OK| |
| | ::: | ::: | application/json | ::: | 401 - Unauthorized| |
| | ::: | ::: |text/plain| ::: |500 - Internal Server Error| |
| | ::: | ::: | text/csv | ::: |::: | |
| |/package/<id>/pathway/<id> | optional parameter "delimiter" for text/csv only, default value: "," | text/html | The pathway identified by the URI. | 200 - OK| |
| | ::: | ::: | application/json | ::: | 401 - Unauthorized| |
| | ::: | ::: |text/plain| ::: |404 - Not Found| |
| | ::: | ::: | text/csv | ::: |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//| | List of all pathways of all packages that the user has permission to read. | 303 - See Other| |
| | ::: | //reverse// | ::: | ::: | 500 - Internal Server Error| |
| | ::: |//name// |:::| ::: | | |
| | ::: |// description// | ::: | ::: |::: | |
| | ::: |// rootOnly// | ::: | ::: |::: | |
| | ::: |// selectedSetting// | ::: | There are 3 ways to select the [[settings|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.|::: | |
| | ::: |// <settingParams>// | ::: | |::: | |
| |/package/<id>/pathway |//smilesinput//| | 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| |
| | ::: | //reverse// | ::: | ::: | 401 - Unauthorized| |
| | ::: |//name// |:::| ::: |500 - Internal Server Error| |
| | ::: |//selectedSetting// |:::| ::: |:::| |
| | ::: |//<settingParams>// |:::| ::: |:::| |
| |/package/<id>/pathway/<id>|//pathwayName//| | Modify the pathway identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. | 200 - OK| |
| | ::: | //setAsDefaultName// | ::: | ::: | 401 - Unauthorized| |
| | ::: | //pathwayDescription// | ::: | ::: | 404 - Not Found| |
| | ::: | //scenario - URI of the scenario// | ::: | ::: | 500 - Internal Server Error| |
| |/package/<id>/pathway/<id>/node|//nodeAsSmiles//| | Adds a new node to the pathway. | 200 - OK| |
| | ::: | //nodeReason// | ::: | ::: | 401 - Unauthorized| |
| | ::: | //nodeName// | ::: | ::: | 404 - Not Found| |
| | ::: | //nodeDepth// | ::: | ::: | 500 - Internal Server Error| |
| |/package/<id>/pathway/<id>/node/<id>|//nodeName//| | Modify the node identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. | 200 - OK| |
| | ::: | //setAsDefaultName// | ::: | ::: | 401 - Unauthorized| |
| | ::: | //nodeDescription// | ::: | ::: | 404 - Not Found| |
| | ::: | //nodeDescription// | ::: | ::: | 500 - Internal Server Error| |
| |/package/<id>/pathway/<id>/edge|//edgeAsSmirks//| | Adds a new edge to the pathway. | 200 - OK| |
| | ::: | //edgeReason// | ::: | ::: | 401 - Unauthorized| |
| | ::: | //products// | ::: | ::: | 404 - Not Found| |
| | ::: | //educts// | ::: | ::: | 500 - Internal Server Error| |
| | ::: | //multistep// | ::: | ::: | :::| |
| |/package/<id>/pathway/<id>/edge/<id>|//edgeName//| | Modify the edge identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. | 200 - OK| |
| | ::: | //setAsDefaultName// | ::: | ::: | 401 - Unauthorized| |
| | ::: | //edgeDescription// | ::: | ::: | 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| |
| |
| |
| |
| ==== PUT ==== |
| |
| Not Implemented. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |