ExchangeItemsApi
All URIs are relative to http://localhost:50051
| Method | HTTP request | Description |
|---|---|---|
| getcomponentname | GET /getcomponentname | |
| getinputitem_count | GET /getinputitem_count | |
| getinputvar_names | GET /getinputvar_names | |
| getoutputitem_count | GET /getoutputitem_count | |
| getoutputvar_names | GET /getoutputvar_names |
getcomponentname
getcomponentname(api::ExchangeItemsApi; _mediaType=nothing) -> GetComponentNameResponse, OpenAPI.Clients.ApiResponse <br/> getcomponentname(api::ExchangeItemsApi, response_stream::Channel; _mediaType=nothing) -> Channel{ GetComponentNameResponse }, OpenAPI.Clients.ApiResponse
Get the name of the model component.
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]
getinputitem_count
getinputitemcount(api::ExchangeItemsApi; mediaType=nothing) -> Int64, OpenAPI.Clients.ApiResponse <br/> getinputitemcount(api::ExchangeItemsApi, responsestream::Channel; _mediaType=nothing) -> Channel{ Int64 }, OpenAPI.Clients.ApiResponse
The number of variables the model can use from other models implementing a BMI.
Required Parameters
This endpoint does not need any parameter.
Return type
Int64
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]
getinputvar_names
getinputvarnames(api::ExchangeItemsApi; mediaType=nothing) -> Vector{String}, OpenAPI.Clients.ApiResponse <br/> getinputvarnames(api::ExchangeItemsApi, responsestream::Channel; _mediaType=nothing) -> Channel{ Vector{String} }, OpenAPI.Clients.ApiResponse
Gets an array of names for the variables the model can use from other models implementing a BMI.
Required Parameters
This endpoint does not need any parameter.
Return type
Vector{String}
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]
getoutputitem_count
getoutputitemcount(api::ExchangeItemsApi; mediaType=nothing) -> Int64, OpenAPI.Clients.ApiResponse <br/> getoutputitemcount(api::ExchangeItemsApi, responsestream::Channel; _mediaType=nothing) -> Channel{ Int64 }, OpenAPI.Clients.ApiResponse
The number of variables the model can provide other models implementing a BMI.
Required Parameters
This endpoint does not need any parameter.
Return type
Int64
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]
getoutputvar_names
getoutputvarnames(api::ExchangeItemsApi; mediaType=nothing) -> Vector{String}, OpenAPI.Clients.ApiResponse <br/> getoutputvarnames(api::ExchangeItemsApi, responsestream::Channel; _mediaType=nothing) -> Channel{ Vector{String} }, OpenAPI.Clients.ApiResponse
Gets an array of names for the variables the model can provide to other models implementing a BMI.
Required Parameters
This endpoint does not need any parameter.
Return type
Vector{String}
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]