Scenario

From enviPath Wiki
Jump to navigation Jump to search

REST Operations

GET

URI Parameter Accept Types Result Status Codes
/scenario

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/plain

text/csv

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

500 - Internal Server Error

/package/<id>/scenario

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/plain

text/csv

List of all pathways of all the package given by the URI. 200 - OK

401 - Unauthorized

500 - Internal Server Error

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

optional parameter "delimiter" for
text/csv only, default value: ","

text/html

application/json

text/plain

text/csv

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

setAsDefaultName

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 (*)

Modify the scenario identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name. 200 - OK

401 - Unauthorized

404 - Not Found

500 - Internal Server Error

(*) Type parameters

waterstoragecapacity:

  • wst
  • wstConditions

omcontent:

  • omcontent
  • omDim

soilsource:

  • soilsourcedata

temperature:

  • temperature

humidity:

  • expHumid

spikeconcentration:

  • spikeConcentration

spikecompound:

  • spikeCompSmiles
  • spikeComp

bulkdens:

  • bulkdensity

biomass:

  • biomassStart
  • biomassEnd

rulelikelihood:

  • ruleLikelihood

redox:

  • redoxType

soiltexture2:

  • sand
  • silt
  • clay

soiltexture1:

  • soilTextureType

soilclassificationsystem:

  • soilclassificationsystem

cec:

  • cecdata

reference:

  • reference
  • pmid

acidity:

  • lowPh
  • highPh

DELETE

URI Parameter Accept Types Result Status Codes
/package/<id>/scenario/<id> Delete the pathway identified by the URI. 303 - See Other

401 - Unauthorized

404 - Not Found

500 - Internal Server Error

PUT

Not Implemented.