erecord Web API¶
Introduction¶
The web services provided by erecord allow to edit, modify and simulate some agronomic model s of the Record platform, and more generally some vle model s.
The ‘vpz’ web services¶
The ‘vpz’ web services are provided by the erecord_vpz application. They allow to modify and run simulators.
The activities on vpz (as VpzAct) consist in : seeing and may be modifying vpz input information, running simulation and seeing the resulting vpz output information.
With reports on vpz (as VpzAct), the returned results are some file reports.
With experiment, you build your own experiment plan from a vpz (as VpzAct) and get the simulation results into xls files.
Some other ‘vpz’ web services : lists and details, menus.
The ‘db’ web services¶
The ‘db’ web services are provided by the erecord_db application that is dedicated to the models repositories that are recorded into the database (as VleRep , VlePkg, VleVpz).
If the erecord_db application is installed, then the vpz (as VpzAct) of the ‘vpz’ web services can be defined from a VleVpz.
The ‘db’ web services are mainly menus, lists and details.
The ‘slm’ web services¶
The ‘slm’ web services are provided by the erecord_slm application that is dedicated to downloadable files management.
A downloadable file results from a request (such as GET vpz/report/conditions, POST vpz/report, POST vpz/experiment…) that had been sent by asking to download the result file later on (see mode for todownload option).
The ‘acs’ web services¶
The ‘acs’ web services are provided by the erecord_acs application that is dedicated to access management (authentication…).
A model can be public or in limited access.
See Model access (public or limited) | JSON Web Token authentication
The ‘acs’ web services allow to get and verify a token (JSON Web Token), to get information about simulators access (simulators as VleVpz or as VpzPath).