VariableInformationApi
All URIs are relative to http://localhost:50051
| Method | HTTP request | Description |
|---|---|---|
| getvargrid | GET /getvargrid/{name} | |
| getvaritemsize | GET /getvaritemsize/{name} | |
| getvarlocation | GET /getvarlocation/{name} | |
| getvarnbytes | GET /getvarnbytes/{name} | |
| getvartype | GET /getvartype/{name} | |
| getvarunits | GET /getvarunits/{name} |
getvargrid
getvargrid(req::HTTP.Request, name::String;) -> Int64
Each input and output variable is defined on a grid. This function returns the grid identifier for a given variable.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| name | String | [default to nothing] |
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]
getvaritemsize
getvaritemsize(req::HTTP.Request, name::String;) -> Int64
Provides the size, in bytes, of a single element of the variable.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| name | String | [default to nothing] |
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]
getvarlocation
getvarlocation(req::HTTP.Request, name::String;) -> GetVarLocationResponseLocation
Indicates on what grid element the variable is defined.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| name | String | [default to nothing] |
Return type
GetVarLocationResponseLocation
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]
getvarnbytes
getvarnbytes(req::HTTP.Request, name::String;) -> Int64
Provides the total amount of memory used to store a variable; i.e., the number of items multiplied by the size of each item.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| name | String | [default to nothing] |
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]
getvartype
getvartype(req::HTTP.Request, name::String;) -> GetVarTypeResponse
Provides the data type of the variable.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| name | String | [default to nothing] |
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]
getvarunits
getvarunits(req::HTTP.Request, name::String;) -> GetVarUnitsResponse
Get the units of the given variable.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request | The HTTP Request object | |
| name | String | [default to nothing] |
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]