POST vpz/inout¶
Description¶
Maybe modifies the input conditions of a simulator (see input information of a vpz) (depending on the request parameters). In addition with this input conditions modification (optional), maybe modifies the input datas folder of the simulator according to a posted file (optional). Then runs the simulation and returns the simulation results (see output information of a vpz) and also 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.
- input datas folder
- The file (optional) posted to modify the input datas folder is a zip file given by the user into the POST request (HTTP multipart request) as ‘datafolder’ parameter. The way how this zip file content is taken into account depends on the ‘datafoldercopy’ parameter value.
filtering
It is possible to ask for filtering some of the returned information (see ‘parselect’, ‘outselect’).
- style
- Only the style main values ‘link’ and ‘tree’ are available (the ‘compact’ and ‘compactlist’ values are not available).
Help¶
See an example as help on how to know the simulators that can be chosen with the ‘vpz’ option.
Before a POST vpz/inout 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.
Example¶
-> See also Seeing and running the modified simulator.
-> Example using datafolder, datafoldercopy : In command line with cURL