EngineeringUnitCatalog

Description

Retrieves the Engineering Unit Catalog from your AVEVA Insight solution

URL

/EngineeringUnitCatalog

Method

GET 

Required Parameters

• System=[string]
  The name of the system of measure. For example, SI, US, British Imperial.

• Dimension=[string ]
  The unit of measure's dimension name. For example, temperature, flow rate, length.

• Symbol=[string]
  Canonical (standard) symbol used by the system of measurement that the unit belongs to. May contain special characters, such as the degree symbol for temperature measurements (for example, 68°).

• BasicSymbol=[string ]
  Canonical (standard) symbol used by the system of measurement that the unit belongs to. May not contain special characters.

• Description=[string]
  A more descriptive name for the unit.

• IntegralDivisor=[string]
  The factor to be applied when integrating a rate with the units [EngUnits/TimeUnit] to a quantity with units [EngUnits]. This factor is called the integral divisor. The default value of 1 assumes a time unit of seconds and ensures that a rate of [Unit/second] is correctly integrated to [Unit]. For a time unit of minutes, set the integral divisor value to 60; for a unit of hours, set the integral divisor value to 3600. The integral divisor is applied similarly to rates or quantities that are not expressed in terms of a time unit. For example, to convert watts to watt-hours, the integral divisor is 1/3600. To convert watts to kilowatt-hours, the integral divisor is 1/3600000.

• Offset=[string ]
  The offset used in linear conversion with respect to the base unit (b in the following line equation: y = mx+b.

• Factor=[string]
  The scale factor used in linear conversion with respect to the base unit (m in the following line equation: y = mx+b.

• IsVisible=[string]
  Set to 1 if this unit is displayed when you are creating a new engineering unit, and trying to link it to an existing catalog unit. Default value = 1.

• IsSystem=[string]
  Set to 1 if this unit is defined by the system. Default value = 0.

Success Response

Code: 200

Sample Queries

Scenario 1

This query retrieves the Engineering Unit catalog from the AVEVA Insight solution.

https://online.wonderware.[DOMAINSUFFIX]/apis/Historian/V2/EngineeringUnitCatalog