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 allow to modify and run simulators.
To act on a simulator, it is necessary to know its Id. This one can be found thanks to the ‘db’ web services, that allow to identify the models repositories, their models and simulators.
Some models are in public access and some models are in limited access. Authentication is required in limited access case (see JSON Web Token authentication).
Resources¶
- The ‘vpz’ web services to modify and run simulators :
| Resource | Description | |
|---|---|---|
| GET vpz/input | to see a simulator | |
| POST vpz/input | to see a modified simulator | Try |
| GET vpz/output | to run a simulator | |
| POST vpz/output | to run a modified simulator | Try |
| GET vpz/inout | to see and run a simulator | |
| POST vpz/inout | to see and run a modified simulator | Try |
_
| Resource | Description | |
|---|---|---|
| GET vpz/experiment | to see a simulator by xls file | Try (‘first step’) |
| POST vpz/experiment | to run a modified simulator by xls file | Try |
_
| Resource | Description |
|---|---|
| GET vpz/report | for reports about a simulator (conditions and results) |
| POST vpz/report | for reports about a modified simulator (conditions and results) |
| GET vpz/report/conditions | for reports about a simulator conditions |
| POST vpz/report/conditions | for reports about a modified simulator conditions |
- The ‘db’ web services to identify the models repositories, their models and simulators :
| Resource | Description |
|---|---|
| GET db/rep | to identify some models repositories |
| GET db/rep/{Id} | to identify a models repository |
| GET db/pkg | to identify some models |
| GET db/pkg/{Id} | to identify a model |
| GET db/vpz | to identify some simulators |
| GET db/vpz/{Id} | to identify a simulator |
_
| Resource | Description |
|---|---|
| GET db/rep/{Id}/name | to get the name of a models repository |
| GET db/pkg/{Id}/name | to get the name of a model |
| GET db/pkg/{Id}/datalist | to get the list of names of data files of a model |
| GET db/vpz/{Id}/name | to get the name of a simulator |
- The ‘slm’ web services to download some result files :
| Resource | Description |
|---|---|
| GET slm/download | to download a result file |
- The ‘acs’ web services to manage simulators access (public or limited) :
Authentication by JWT (JSON Web Token) for limited access case :
| Resource | Description |
|---|---|
| POST acs/jwt/obtain | to get a JWT value |
| POST acs/jwt/verify | to verify a JWT value |
_
| Resource | Description |
|---|---|
| GET acs/vpz/{Id}/access | to get the access type (limited or public) of a simulator (vpz) |
| GET acs/vpz/{Id}/user/id | to get the list of id of a simulator (vpz) authorized users |
| GET acs/vpz/{Id}/user/name | to get the list of name of a simulator (vpz) authorized users |
| GET acs/vpz/accessible/id | to get the list of id of the accessible simulators (vpz) |
_
| Resource | Description |
|---|---|
| GET acs/vpzpath/{Id}/access | to get the access type (limited or public) of a simulator (vpzpath) |
| GET acs/vpzpath/{Id}/user/id | to get the list of id of a simulator (vpzpath) authorized users |
| GET acs/vpzpath/{Id}/user/name | to get the list of name of a simulator (vpzpath) authorized users |
| GET acs/vpzpath/accessible/id | to get the list of id of the accessible simulators (vpzpath) |