GET api/v{version}/Variables

Gets the variables for a project.

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

None.

Response Information

Resource Description

A list of metocean variables.

Collection of MetoceanVariable

Name	Description	Type	Additional 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
  },
  {
    "Id": 2,
    "Name": "Wave period",
    "Units": "secs",
    "IsDirection": false,
    "IsBelowThresholdSuccess": true
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.