Common Methods (Available in BaseClient)

All client classes inherit from BaseClient<TDataSource> and have access to the following common methods:

GetDataSources

Retrieves list of available datasources.

Signature:

Task<IEnumerable<TDataSource>> GetDataSources(string filter = "")

GetDataSource

Retrieves specific datasource information.

Signature:

Task<TDataSource> GetDataSource(string datasourceName, string filter = "")

GetMetaData

Retrieves metadata information from the datasource.

Signature:

Task<IEnumerable<KeyValuePair<string, string>>> GetMetaData(string datasourceName)

GetTables

Retrieves list of available tables.

Signature:

Task<DataTable> GetTables(string datasourceName, string filter = "")

GetTableData

Retrieves table data with optional filtering.

Signature:

Task<DataTable> GetTableData(string datasourceName, string tableName, string filter = "")

GetTableSchema

Retrieves table schema.

Signature:

Task<DataTable> GetTableSchema(string datasourceName, string tableName)

GetData

Retrieves data using a predefined request path.

Signature:

Task<DataTable> GetData(string datasourceName, string requestPath)

GetAcknowledgements

Retrieves list of acknowledgements for a datasource.

Signature:

Task<IEnumerable<Acknowledgement>> GetAcknowledgements(string datasourceName)

GetTableDataByAcknowledgementId

Retrieves table data using acknowledgement ID.

Signature:

Task<DataTable> GetTableDataByAcknowledgementId(string datasourceName, string acknowledgementId)

GetAcknowledgementMetaData

Retrieves metadata for a specific acknowledgement.

Signature:

Task<AckMetaData> GetAcknowledgementMetaData(string dataSourceName, string acknowledgementId)

GetAcknowledgementDataWithChunkId

Retrieves acknowledgement data by chunk ID.

Signature:

Task<DataTable> GetAcknowledgementDataWithChunkId(string datasourceName, string acknowledgementId, int chunkId)

PostTables

Posts list of tables information.

Signature:

Task<AcknowledgementResult> PostTables(

string datasourceName,

List<Table> tables,

string AckId,

string Context = "",

string Topic = "",

int expiryDuration = 0

)

PostTableData

Posts table data to the datasource.

Signature:

Task<AcknowledgementResult> PostTableData(

string datasourceName,

string tableName,

DataTable data,

string AckId,

string Context = "",

string Topic = "",

int expiryDuration = 0

)

DeleteAcknowledgement

Deletes a specific acknowledgement.

Signature:

Task<DeleteAckResult> DeleteAcknowledgement(string datasourceName, string acknowledgementId)

DeleteAllAcknowledgements

Deletes all acknowledgements for a datasource.

Signature:

Task<DeleteAckResult> DeleteAllAcknowledgements(string datasourceName)

RegisterTokenRefreshHandler

Registers a token refresh handler.

Signature:

void RegisterTokenRefreshHandler(Func<Task<string>> handler)

HealthCheck

Performs health check on the API.

Signature:

Task<HttpStatusCode> HealthCheck(string baseUrl)