Retrieve Strapping table metadata information using the AVEVA Pipeline Operations for Liquids Tank Strapping Application Program Interface (API)
- Last UpdatedApr 24, 2025
- 1 minute read
Retrieve Strapping table metadata information using the AVEVA Pipeline Operations for Liquids Tank Strapping Application Program Interface (API)
Tank Strapping table information can be retrieved using the AVEVA Pipeline Operations for Liquids Tank Strapping Application Program Interface (API) located in the OASySDNA.LMS.Tank.Strapping assembly. This assembly is automatically included whenever the AVEVA Pipeline Operations for Liquids RealTime or AVEVA Pipeline Operations for Liquids Advanced Database Editor (ADE) components are included in an installation.
Retrieving the Strapping table
All operations against a Strapping table can be performed using the StrappingTableService object.
The following list details the properties of the StrappingTableService object:
-
Namespace: OASySDNA.LMS.Tank.Strapping
-
Assembly: OASySDNA.LMS.Tank.Strapping (found in OASySDNA.LMS.Tank.Strapping.dll)
-
Interface: IStrappingTableService
The following table details the constructor parameters.
|
Name |
Type |
Description |
|---|---|---|
|
strappingName |
String |
The name of the strapping table that operations are to be executed against. This is typically the value configured in the strappingname field of a tank record. |
To retrieve the Strapping table, invoke the StrappingTableService.GetTable() method. (There are no parameters necessary for this step.)
The following table details the return value:
|
Name |
Type |
Description |
|---|---|---|
|
BLTResponse<IStrappingTable> |
N/A |
A response package that contains an indication if the operation was successful or not, the error message (if applicable), and the tank strapping table. |
Example
public void GetStrappingTableInformation(String tableName)
{
var myStrappingTableService = new StrappingTableService(tableName);
var getTableResponse = myStrappingTableService.GetTable();
if (getTableResponse.State != ResponseState.OK)
{
throw new Exception($"Failed to fetch strapping table '{tableName}' ({getTableResponse.State}): {getTableResponse.FailureReason}");
}
var strappingTable = getTableResponse.Value;
}