GET api/v{version}/Variables?id={id}

Gets the variable with the given ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required
version

string

None.

Body Parameters

None.

Response Information

Resource Description

A metocean variable.

MetoceanVariable
NameDescriptionTypeAdditional information
Id

The ID of the variable.

 integer

Required
Name

The name of the variable.

 string

None.
Units

The units for the variable.

 string

None.
IsDirection

Indicates whether or not the variable is directional.

 boolean

None.
IsBelowThresholdSuccess

If true, any threshold defined for this variable determines the value below which time series values must fall in order for an operation to be viable. If false, any threshold defined for this variable determines the value above which time series values must fall in order for an operation to be viable.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "Significant wave height",
  "Units": "m",
  "IsDirection": false,
  "IsBelowThresholdSuccess": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.