Difference between revisions of "Scenario"

From enviPath Wiki
Jump to navigation Jump to search
(Created page with "= REST Operations = == GET == {| class="wikitable" |- !URI !Parameter !Accept Types !Result !Status Codes |- |/scenario | |''text/html'' ''application/json'' ''text/plain'...")
 
Line 90: Line 90:


''ppsObjects'' - Attach scenario to array of pathway/compound/reaction/rules URIs
''ppsObjects'' - Attach scenario to array of pathway/compound/reaction/rules URIs
-----
''copy'' - Makes copy of scenario and redirects to new scenario


|
|

Revision as of 10:44, 21 October 2015

REST Operations

GET

URI Parameter Accept Types Result Status Codes
/scenario text/html

application/json

text/plain

List of all scenarios of all packages that the user has permission to read. 200 - OK

500 - Internal Server Error

/package/<id>/scenario 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>/scenario/<id> text/html

application/json

text/plain

The scenario identified by the URI. 200 - OK

401 - Unauthorized

404 - Not Found

500 - Internal Server Error


POST

URI Parameter Accept Types Result Status Codes
/scenario

/package/<id>/scenario

studyname

collectionURI

studydescription

date

Creates a new scenario in the selected/default package. The redirect points to the URI of the new scenario. 303 - See Other

500 - Internal Server Error

/package/<id>/scenario/<id> scenarioName

scenarioDescription

scenarioDate


ppsObjects - Attach scenario to array of pathway/compound/reaction/rules URIs


copy - Makes copy of scenario and redirects to new scenario

Modify the scenario 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.