POST vpz/output¶
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).
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 ‘outselect’).
- style
In addition to the style values ‘link’ and ‘tree’, the ‘compact’ value is also available (and also ‘compactlist’ value, having here the same meaning as ‘compact’ value). The default style value is ‘tree’.
The ‘compact’ value is for the output datas to be named by their ‘selection_name’.
- style, restype
- The ‘compact’ (and ‘compactlist’) style value has an effect only in case of ‘dataframe’ value for restype (no effect if ‘matrix’ value for restype).
Help¶
See an example as help on how to know the simulators that can be chosen with the ‘vpz’ option.
Before a POST vpz/output 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, 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¶
-> Example : In a webbrowser | In command line with cURL | In Python language | In R language | In PHP language | In C++ language
-> Example : In a webbrowser | In command line with cURL | In Python language | In R language | In PHP language | In C++ language
-> Example using datafolder, datafoldercopy : In command line with cURL