Difference between revisions of "Pathway"

From enviPath Wiki
Jump to navigation Jump to search
Line 22: Line 22:
500 - Internal Server Error
500 - Internal Server Error
|-
|-
|/package/<id>/compound
|/package/<id>/pathway
|
|
|''text/html''
|''text/html''
Line 29: Line 29:


''text/plain''
''text/plain''
|List of all compounds of all the package given by the URI.
|List of all pathways of all the package given by the URI.
|200 - OK
|200 - OK


Line 36: Line 36:
500 - Internal Server Error
500 - Internal Server Error
|-
|-
|/package/<id>/compound/<id>
|/package/<id>/pathway/<id>
|
|
|''text/html''
|''text/html''
Line 44: Line 44:
''text/plain''
''text/plain''


|The compound identified by the URI.
|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
|200 - OK


Line 77: Line 89:
''<settingParams>''
''<settingParams>''
|
|
|Create a new pathway in the default package. The redirect points to the URI of the new pathway.
|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 [[Settings|setting]] for the pathway:
There are 3 ways to select the [[Settings|setting]] for the pathway:
Line 86: Line 98:
500 - Internal Server Error
500 - Internal Server Error
|-
|-
|/package/<id>/compound
|/package/<id>/pathway
|''compoundSmiles''
|''smilesinput''
''reverse''
 
''name''
 
''selectedSetting''


''compoundName''
''isNew''


''compoundDescription''
''<settingParams>''
|
|
|Create a new Compound in the package given by the URI. The redirect points to the URI of the new Compound.
|Creates a new predicted pathway in the package given by the URI. The redirect points to the URI of the new Compound.
|303 - See Other
|303 - See Other


Line 134: Line 151:
500 - Internal Server Error
500 - Internal Server Error
|-
|-
|/package/<id>/compound
|/package/<id>/pathway
|
|
|
|
|Delete all compounds in the package given by the URI.
|Delete all pathways in the package given by the URI.
|303 - See Other
|303 - See Other


Line 144: Line 161:
500 - Internal Server Error
500 - Internal Server Error
|-
|-
|rowspan="4"|/package/<id>/compound/<id>
|rowspan="4"|/package/<id>/pathway/<id>
|rowspan="4"|
|rowspan="4"|
|rowspan="4"|
|rowspan="4"|
|rowspan="4"|Delete the compound identified by the URI.  
|rowspan="4"|Delete the pathway identified by the URI.  
| 303 - See Other
| 303 - See Other
|-
|-

Revision as of 09:25, 21 October 2015

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

isNew

<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
* Set isNew to true and provide a 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 Compound. 303 - See Other

401 - Unauthorized

500 - Internal Server Error

/package/<id>/compound/<id> compoundSmiles Modify the compound identified by the URI. 200 - OK
compoundName 401 - Unauthorized
compoundDescription 404 - Not Found
scenario - URI of the scenario 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



PUT

Not Implemented.