POST vpz/input¶
Description¶
Returns the input conditions of a simulator (see input information of a vpz), maybe after modifications (depending on the request parameters).
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’).
- style
In addition to the style values ‘link’ and ‘tree’, the ‘compact’ and ‘compactlist’ values are also available. The default style value is ‘compact’.
The ‘compact’ value is for a compact presentation keeping only some useful parts of information.
The ‘compactlist’ value is for a presentation even compacter than with ‘compact’ style, where in particular the parameters are named by their ‘selection_name’.
Note
Values ordered from the fuller to the lighter style presentation : ‘tree’, ‘compact’, ‘compactlist’.
Help¶
See an example as help on how to know the simulators that can be chosen with the ‘vpz’ option.
Before a POST vpz/input 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). 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
See others examples in Seeing the modified simulator.