Spreadsheet

Water treatment, purpose built data models of tabular data related to water treatment operations. Used in conjunction with Enterprise Twins to model the treatment process and Common Computations to calculate data needed to operate treatment processes and facilities within regulatory compliance.

class ClientSDK.Spreadsheet.Report

Methods

CellValidateAsync

Validates the provided cell. This is the same validation that takes place on a save request but without actually saving the cell.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.CellValidateAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, Cell cell)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • cell (Cell) – The Cell to validate.

Returns

User Object that matches the User Protocol Buffer.

Return type

Task<Cell>

ColumnGetByDayAsync

Returns column data based on day, month and year

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-GRAPHS

ClientSDK.Spreadsheet.ColumnGetByDayAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, uint columnId, DateTime date)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • columnId (uint) – The numeric id or column number.

  • date (DateTime) – The Date to retrieve the Column.

Returns

A collection of measurements that match the date specified.

Return type

Task<List<Measurement>>

ColumnGetByMonthAsync

Returns column data based on month and year of the passed in date

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-GRAPHS

ClientSDK.Spreadsheet.ColumnGetByMonthAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, uint columnId, DateTime date)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • columnId (uint) – The numeric id or column number.

  • date (DateTime) – The Date to retrieve the Column.

Returns

A collection of measurements that match the date specified.

Return type

Task<List<Measurement>>

ColumnGetByYearAsync

Returns column data based on year of the passed in date

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-GRAPHS

ClientSDK.Spreadsheet.ColumnGetByYearAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, uint columnId, DateTime date)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • columnId (uint) – The numeric id or column number.

  • date (DateTime) – The Date to retrieve the Column.

Returns

A collection of measurements that match the date specified.

Return type

Task<List<Measurement>>

ComputationCreateAsync

Creates a new spreadsheet computation.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.COMPUTATIONS_WRITE

ClientSDK.Spreadsheet.ComputationCreateAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, SpreadsheetComputation spreadsheetComputation)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • spreadsheetComputation (SpreadsheetComputation) – The computation related to the column.

Returns

A SpreadsheetComputation object.

Return type

Task<SpreadsheetComputation>

ComputationExecuteAsync

Executes all computations based on column number, start row or end row.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-EDIT

ClientSDK.Spreadsheet.ComputationExecuteAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, uint startRow, uint endRow, DataSourceBinding dataSourceBinding)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • startRow (uint) – Start Row number for computation execution.

  • endRow (uint) – End Row number for computation execution.

Return type

Task<SpreadsheetComputation>

ComputationGetOneAsync

Retrieves a computation based on the Computation Binding ID.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-EDIT

ClientSDK.Spreadsheet.ComputationGetOneAsync(string twinReferenceId, EnumWorksheet worksheetType, string computationBindingId)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • computationBindingId (string) – Binding ID of the computation to be retrieved.

Return type

Task<SpreadsheetComputation>

ComputationGetOneAsync

Validates a computation payload.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-EDIT

ClientSDK.Spreadsheet.ComputationValidateAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, SpreadsheetComputation spreadsheetComputation)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • spreadsheetComputation (SpreadsheetComputation) – The computation related to the column.

Return type

Task<List<ApiError>>

DeletePlantAsync

Delete all entities associated with a plant including Spreadsheet/Worksheet Definition, Rows, RowIndices, Computations, Twins, Configurations and Reports.

ClientSDK.Spreadsheet.DeletePlantAsync(string operationTwinReferenceId)
Parameters

operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

Returns

Whether the plant was successfully deleted.

Return type

Task<bool>

FlushPlantAsync

Flushes data from the speed layer to the batch layer based on Plant ID.

ClientSDK.Spreadsheet.FlushPlantAsync(string operationTwinReferenceId)
Parameters

operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

Returns

Whether the plant was successfully deleted.

Return type

Task<bool>

GetRowsAsync

Retrieves rows based on start row and end row number.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.GetRowsAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, uint startRow, uint endRow, string columnList = null, string viewId = null)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • startRow (uint) – Start Row number for computation execution.

  • endRow (uint) – End Row number for computation execution.

  • columnList (string) – (Optional) coma delimited list of the Column Numbers to retrieve.

  • viewId (string) – (Optional) View ID (GUID) to filter the columns of the rows which are returned.

Return type

Task<Rows>

GetRowsByDayAsync

Retrieves rows based on day, month and year.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.GetRowsByDayAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, DateTime date, string columnList = null, string viewId = null)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • date (DateTime) – The Date to retrieve the rows.

  • columnList (string) – (Optional) coma delimited list of the Column Numbers to retrieve.

  • viewId (string) – (Optional) View ID (GUID) to filter the columns of the rows which are returned.

Return type

Task<Rows>

GetRowsByMonthAsync

Retrieves rows based on month and year.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.GetRowsByMonthAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, DateTime date, string columnList = null, string viewId = null)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • date (DateTime) – The Date to retrieve the rows.

  • columnList (string) – (Optional) coma delimited list of the Column Numbers to retrieve.

  • viewId (string) – (Optional) View ID (GUID) to filter the columns of the rows which are returned.

Return type

Task<Rows>

GetSpreadsheetDefinitionAsync

Retrieves spreadsheet definition based on plant ID.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.GetSpreadsheetDefinitionAsync(string operationTwinReferenceId)
Parameters

operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

Return type

Task<SpreadsheetDefinition>

GetWorksheetDefinitionAsync

Retrieves worksheet definition based on plant ID and worksheet type.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.GetWorksheetDefinitionAsync(string operationTwinReferenceId, EnumWorksheet worksheetType)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

Return type

Task<WorksheetDefinition>

SaveRowsAsync

Creates new rows or updates existing rows based on Plant ID and Worksheet Type.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.SaveRowsAsync(Rows rows, string operationTwinReferenceId, EnumWorksheet worksheetType)
Parameters

  • rows (Rows) – The rows to be saved.

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

Return type

Task<bool>

SaveSpreadsheetDefinitionAsync

Creates new spreadsheet definition or updates existing spreadsheet definition based on Plant ID.

  • RESTful API Documentation

  • Required Role(s): Admin, Support Admin, Claros Admin

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-CONFIGURE

ClientSDK.Spreadsheet.SaveSpreadsheetDefinitionAsync(string operationTwinReferenceId, SpreadsheetDefinition spreadsheetDefinition)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • spreadsheetDefinition (SpreadsheetDefinition) – The definition of the spreadsheet.

Return type

Task<bool>

WorksheetAddColumnAsync

Adds worksheet definition columns based on plant ID and worksheet type.

  • RESTful API Documentation

  • Required Role(s): Admin, Support Admin, Claros Admin

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-CONFIGURE

ClientSDK.Spreadsheet.WorksheetAddColumnAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, WorksheetDefinition worksheetDefinition)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • worksheetDefinition (WorksheetDefinition) – The definition of the worksheet.

Return type

Task<bool>

Note

This endpoint supports creating 2000 worksheet columns per request. It is expected to create 80-100 columns per second. For scenarios that require creating more than 2000 columns, it is required to create columns in batches.

WorksheetUpdateColumnAsync

Updates worksheet definition columns based on plant ID and worksheet type.

  • RESTful API Documentation

  • Required Role(s): Admin, Support Admin, Claros Admin

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-CONFIGURE

ClientSDK.Spreadsheet.WorksheetUpdateColumnAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, WorksheetDefinition worksheetDefinition)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

  • worksheetDefinition (WorksheetDefinition) – The definition of the worksheet.

Return type

Task<bool>

TODO (Missing) Methods

BackupSpreadsheetAsync

This copies the spreadsheet data for a plant/operation to long term storage.

  • RESTful API Documentation

  • Required Role(s): Support Admin, Claros Admin

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

ClientSDK.Spreadsheet.BackupSpreadsheetAsync(string operationTwinReferenceId)
Parameters

operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

Return type

Task<bool>

RestoreSpreadsheetAsync

This restores the spreadsheet data from a plant/operation to application from backups.

  • RESTful API Documentation

  • Required Role(s): Support Admin, Claros Admin

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

ClientSDK.Spreadsheet.RestoreSpreadsheetAsync(string operationTwinReferenceId)
Parameters

operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

Return type

Task<bool>

BackupSpreadsheetAsync

Cooks the data based on Plant ID.

  • RESTful API Documentation

  • Required Role(s): Support Admin, Claros Admin

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

ClientSDK.Spreadsheet.CookPlantAsync(string operationTwinReferenceId, EnumWorksheet worksheetType)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

Return type

Task<bool>

GetRowIndicesAsync

Retrieves the row indices based on the query criteria provided.

  • RESTful API Documentation

  • Required Role(s): Any

  • Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.

  • Feature Authorization: FEATURE.SPREADSHEET-READ

ClientSDK.Spreadsheet.GetRowIndicesAsync(string operationTwinReferenceId, EnumWorksheet worksheetType, DateTime relativeTime, DateTime utcTime, bool isInSpeed, bool isInCooked, bool is ColumnsCooked)
Parameters

  • operationTwinReferenceId (string) – The unique Identifier (GUID) of the Operation Digital Twin related to the spreadsheet.

  • worksheetType (EnumWorksheet) – The enumeration of the type of worksheet.

Return type

Task<bool>