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(api::TimeInformationApi; _mediaType=nothing) -> Float64, OpenAPI.Clients.ApiResponse <br/> getcurrenttime(api::TimeInformationApi, response_stream::Channel; _mediaType=nothing) -> Channel{ Float64 }, OpenAPI.Clients.ApiResponse
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(api::TimeInformationApi; _mediaType=nothing) -> Float64, OpenAPI.Clients.ApiResponse <br/> getendtime(api::TimeInformationApi, response_stream::Channel; _mediaType=nothing) -> Channel{ Float64 }, OpenAPI.Clients.ApiResponse
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(api::TimeInformationApi; _mediaType=nothing) -> Float64, OpenAPI.Clients.ApiResponse <br/> getstarttime(api::TimeInformationApi, response_stream::Channel; _mediaType=nothing) -> Channel{ Float64 }, OpenAPI.Clients.ApiResponse
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(api::TimeInformationApi; _mediaType=nothing) -> Float64, OpenAPI.Clients.ApiResponse <br/> gettimestep(api::TimeInformationApi, response_stream::Channel; _mediaType=nothing) -> Channel{ Float64 }, OpenAPI.Clients.ApiResponse
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(api::TimeInformationApi; _mediaType=nothing) -> GetTimeUnitsResponse, OpenAPI.Clients.ApiResponse <br/> gettimeunits(api::TimeInformationApi, response_stream::Channel; _mediaType=nothing) -> Channel{ GetTimeUnitsResponse }, OpenAPI.Clients.ApiResponse
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]