POST vpz/report/conditions

Resource URL

http://erecord.toulouse.inra.fr:8000/vpz/report/conditions

Description

Maybe modifies the input conditions of a simulator (see input information of a vpz) (depending on the request parameters), then produces and returns the required reports, from the input conditions (see input information of a vpz).

Details

jwt

If the simulator is in limited access then authentication is required, by a ‘jwt’ parameter containing an available JWT value.

input information

It is possible to modify some of the vpz input information (see ‘pars’, ‘begin’…) and in that case the vpz taken into consideration is the vpz updated by the modifications.

filtering

It is possible to ask for filtering some of the returned information (see ‘parselect’, ‘outselect’).

reports

The built reports are gathered and returned into a ‘.zip’ file.

Help

See an example as help on how to know the simulators that can be chosen with the ‘vpz’ option.

Before a POST vpz/report/conditions command, it may be useful to do a GET vpz/input command with ‘compact’ or ‘compactlist’ style (see mode for style) in order to make easier some modifications (see pars or cname.pname, parselect, outselect). See also help to know how some information is identified/selected in the request.

Request parameters

Required : either vpz or vpzpath must be provided.

Required : jwt in limited access case.

• vpz or vpzpath
• begin
• duration
• pars or cname.pname
• parselect
• mode for bycol
• mode for todownload
• format or format suffix
• jwt

Response result

The returned result is reports about the simulation conditions (from VpzInput).

Example

cURL command line :

curl -H "Content-Type: application/json" -d '{"vpz":266,"duration":4,"cond_wwdm.TI":901.0,"parselect":["cond_wwdm.A","cond_wwdm.B","cond_wwdm.TI"],"mode":"todownload","format":"yaml"}' http://erecord.toulouse.inra.fr:8000/vpz/report/conditions/

More

This resource is part of Web API ‘vpz’