GET vpz/experiment

Resource URL

http://erecord.toulouse.inra.fr:8000/vpz/experiment

Description

Returns a xls file containing the experiment conditions of the simulator (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.

The returned file is a xls file (see below The returned file).

Help

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

A GET vpz/experiment command may be useful before a POST vpz/experiment command, in order to easierly build the xls file that is required into POST vpz/experiment request. Indeed :

• The posted xls file of the POST vpz/experiment request has the same format and structure than the xls file returned by the GET vpz/experiment request.
• The xls file returned by the GET vpz/experiment request contains some instructions (in blue text) helping to modify it, if wanted to use it as the posted xls file of a POST vpz/experiment request.
• For example the posted xls file of a POST vpz/experiment request has been written from the xls file returned by a GET vpz/experiment request.

Request parameters

Required : either vpz or vpzpath must be provided.

Required : jwt in limited access case.

• vpz or vpzpath
• mode for todownload
• format or format suffix
• jwt

Response result

The returned result is a file report about VpzInput.

The returned file

The returned xls file contains the experiment conditions of the simulator :

• General information : plan (with a default value among the ‘single’ and ‘linear’ available values), restype (with a default value among the ‘dataframe’ and ‘matrix’ available values), begin, duration.
• Parameters values : list of all the parameters values.
• Parameters identification : list of all the parameters.
• Output datas identification : list of the output datas.

Limit : in case of xls file overflow (sheets limited to 256 columns and 65536 rows) the results will be truncated (without any warning).

Example of a returned xls file

Example

Example : In command line with cURL (‘first step’).

Example : in menus under the page Select, modify and run a simulator, the ‘First step : download the xls file to fill in’ consists in a GET vpz/experiment request. Try.

More

This resource is part of Web API ‘vpz’