TimeInformationApi
All URIs are relative to http://localhost:50051
| Method | HTTP request | Description |
|---|---|---|
| getcurrenttime | GET /getcurrenttime | |
| getendtime | GET /getendtime | |
| getstarttime | GET /getstarttime | |
| gettimestep | GET /gettimestep | |
| gettimeunits | GET /gettimeunits |
getcurrenttime
getcurrenttime(req::HTTP.Request;) -> Float64
The current model time.
Required Parameters
This endpoint does not need any parameter.
Return type
Float64
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]
getendtime
getendtime(req::HTTP.Request;) -> Float64
The end time of the model.
Required Parameters
This endpoint does not need any parameter.
Return type
Float64
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]
getstarttime
getstarttime(req::HTTP.Request;) -> Float64
The start time of the model.
Required Parameters
This endpoint does not need any parameter.
Return type
Float64
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]
gettimestep
gettimestep(req::HTTP.Request;) -> Float64
Get the time step used in the model.
Required Parameters
This endpoint does not need any parameter.
Return type
Float64
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]
gettimeunits
gettimeunits(req::HTTP.Request;) -> GetTimeUnitsResponse
Get the units of time as reported by the model’s BMI. If model has absolute start time, you can use since format, see cfconventions.
Required Parameters
This endpoint does not need any parameter.
Return type
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]