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'...")
 
 
(6 intermediate revisions by 2 users not shown)
Line 13: Line 13:
|/scenario
|/scenario
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


Line 18: Line 20:


''text/plain''
''text/plain''
''text/csv''
|List of all scenarios of all packages that the user has permission to read.
|List of all scenarios of all packages that the user has permission to read.
|200 - OK
|200 - OK
Line 24: Line 28:
|/package/<id>/scenario
|/package/<id>/scenario
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


Line 29: Line 35:


''text/plain''
''text/plain''
''text/csv''
|List of all pathways 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 38: Line 46:
|/package/<id>/scenario/<id>
|/package/<id>/scenario/<id>
|
|
''optional parameter "delimiter" for<br />
text/csv only, default value: ","''
|''text/html''
|''text/html''


Line 44: Line 54:
''text/plain''
''text/plain''


''text/csv''
|The scenario identified by the URI.
|The scenario identified by the URI.
|200 - OK
|200 - OK
Line 53: Line 64:
500 - Internal Server Error
500 - Internal Server Error
|}
|}


== POST ==
== POST ==
Line 82: Line 92:
|/package/<id>/scenario/<id>
|/package/<id>/scenario/<id>
|''scenarioName''
|''scenarioName''
''setAsDefaultName''


''scenarioDescription''
''scenarioDescription''
Line 91: Line 103:
''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
-----
''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.  
|Modify the scenario identified by the URI. Set setAsDefaultName to "setAsDefaultName" to use the new alias as default name.
| 200 - OK
| 200 - OK


Line 101: Line 126:
500 - Internal Server Error
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 ==  
== DELETE ==  
Line 112: Line 182:
!Status Codes
!Status Codes
|-
|-
|/pathway
|/package/<id>/scenario/<id>
|
|
|
|
|Delete all pathways the user has write access on (does not delete created compounds or reactions).
|Delete the pathway identified by the URI.  
|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
|-
|rowspan="4"|/package/<id>/pathway/<id>
|rowspan="4"|
|rowspan="4"|
|rowspan="4"|Delete the pathway identified by the URI.  
| 303 - See Other
| 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
401 - Unauthorized


500 - Internal Server Error
404 - Not Found
|-
|/package/<id>/pathway/<id>/edge/<id>
|
|
|Remove edge from pathway.
|303 - See Other
 
401 - Unauthorized


500 - Internal Server Error
500 - Internal Server Error

Latest revision as of 15:05, 25 January 2016

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.

Retrieved from "https://wiki.envipath.com/index.php?title=Scenario&oldid=307"