scenario
This is an old revision of the document!
Table of Contents
Scenario
REST Operations
GET
URI | Parameter | Accept Types | Result | Status Codes |
---|---|---|---|---|
/scenario | optional parameter “delimiter” for text/csv only, default value: “,” | text/html | List of all scenarios of all packages that the user has permission to read. | 200 - OK |
application/json | 500 - Internal Server Error | |||
text/plain | ||||
text/csv | ||||
/package/<id>/scenario | 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>/scenario/<id> | optional parameter “delimiter” for text/csv only, default value: “,” | text/html | The scenario identified by the URI. | 200 - OK |
application/json | 401 - Unauthorized | |||
text/plain | 500 - Internal Server Error | |||
text/csv |
POST
URI | Parameter | Accept Types | Result | Status Codes |
---|---|---|---|---|
/scenario | Creates a new scenario in the selected/default package. The redirect points to the URI of the new scenario. | 300 - See Other | ||
/package/<id>/scenario | 500 - Internal Server Error | |||
/package/<id>/scenario/<id> | studyname | Modify the scenario identified by the URI. | 200 - OK | |
collectionURI | 401 - Unauthorized | |||
studydescription | 404 - Not Found | |||
date | 500 - Internal Server Error | |||
scenarioName | ||||
setAsDefaultName | Modify the scenario identified by the URI. Set setAsDefaultName to “setAsDefaultName” to use the new alias as default name. | |||
scenarioDescription | ||||
scenarioDate | ||||
ppsObjects | Attach scenario to array of pathway/compound/reaction/rules URIs | |||
copy | Makes copy of scenario and redirects to new scenario | |||
aiUri | Delete meta-information specified by URI /package/<id>/scenario/<id>/<type> | |||
type | Adds meta-information to the scenario. Possible values: waterstoragecapacity, omcontent, soilsource, temperature, humidity, spikeconcentration, spikecompound, bulkdens, biomass, rulelikelihood, redox, soiltexture2, soiltexture1, soilclassificationsystem, cec, reference, acidity | |||
<type-parameter> - the parameters for each information-type are given below (*) |
scenario.1710853107.txt.gz · Last modified: 2024/03/19 12:58 by shankar