IRFApi
All URIs are relative to http://localhost:50051
| Method | HTTP request | Description |
|---|---|---|
| finalize | DELETE /finalize | |
| initialize | POST /initialize | |
| update | POST /update | |
| update_until | POST /update_until |
finalize
finalize(req::HTTP.Request;) -> Nothing
Performs all tasks that take place after exiting the model’s time loop.
Required Parameters
This endpoint does not need any parameter.
Return type
Nothing
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
initialize
initialize(req::HTTP.Request, initialize_request::InitializeRequest;) -> Nothing
Performs all tasks that are to take place before entering the model’s time loop.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| initialize_request | InitializeRequest |
Return type
Nothing
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update
update(req::HTTP.Request;) -> Nothing
Advances the model by a single time step.
Required Parameters
This endpoint does not need any parameter.
Return type
Nothing
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_until
update_until(req::HTTP.Request, body::Float64;) -> Nothing
Updates the model to a particular time
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| body | Float64 |
Return type
Nothing
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]