Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property
Type
Description
Example
dataProductCodestringReturns the data product code.
"dataProductCode":"HSD"
dataProductName
stringReturns the name of the data product.
"dataProductName":"Hydrophone Spectral Data"
extension
stringReturns the file extension for the data product.
"extension":"png"
hasDeviceDatabooleanReturns whether at least one device and/or sensor with this data product is NEPTUNE searchable"hasDeviceData":true
hasPropertyDatabooleanReturns whether at least one sensor with this data product is a NEPTUNE-searchable primary sensor"hasPropertyData":false
helpDocument
stringReturns a Link URL to the Oceans 3.0 Help documentation for the specific data product.
"helpDocument":"https://wiki.oceannetworks.ca/display/DP/45"
dataProductOptionsarray of objectsArray of all the data product options that can be applied to the specific data product
dataProductOptions.AllowableRangeobjectobject describing the range of values for the specific data product option
dataProductOptions.AllowableRange.lowerBoundStringThe lower bound for the data product option"lowerBound""100"
dataProductOptions.AllowableRange.onlyIntegersbooleanfalse if the number can be floating point"onlyIntegers"true
dataProductOptions.AllowableRange.unitOfMeasureStringThe unit of measure for the data product option"unitOfMeasure""Hz"
dataProductOptions.AllowableRange.upperBoundStringThe upper bound for the data product option"upperBound""500000"
dataProductOptions.allowableValuesArray of stringsThe allowable values for the dataproduct option. If there is an allowable range these values are in addition to the range."allowableValues"["All","LPF","OD","HPF"]
dataProductOptions.documentationArray of stringsList of all the documentation for a data product option"documentation"["https://wiki.oceannetworks.ca/display/DP/Hydrophone+Data+Acquisition+and+Diversion+Mode"]
dataProductOptions.optionStringname of the data product option"option""dpo_hydrophoneDataDiversionMode"
dataProductOptions.suboptionsArray of DataProductOptionssome data product options have children that become required when  you select the parent, for example when you select the "resample" option you must specific the type of resample: avg, minmax, minmaxavg.


Expand
titlesuboption_example

"option": "dpo_resample",
"suboptions": [{
        "allowableRange": null,
        "allowableValues": [],
        "documentation": [
            "https://wiki.oceannetworks.ca/display/DP/Resampling+(Data+Files)"
        ],
        "option": "dpo_none",
        "suboptions": null
    },
    {
        "allowableRange": null,
        "allowableValues": [
            "3600",
            "600",
            "86400",
            "900",
            "60"
        ],
        "documentation": [
            "https://wiki.oceannetworks.ca/display/DP/Resampling+(Data+Files)"
        ],
        "option": "dpo_average",
        "suboptions": null
    },


...