Type Alias DataSourcesAPI

type DataSourcesAPI = {
    clearCache: typeof clearCache;
    getDataSourceApiSpecs: typeof getDataSourceApiSpecs;
    getDataSourceGateways: typeof getDataSourceGateways;
    getDataSources: typeof getDataSources;
    getDataSourceSettings: typeof getDataSourceSettings;
    putDataSourceSettings: typeof putDataSourceSettings;
}
Index

Properties

clearCache getDataSourceApiSpecs getDataSourceGateways getDataSources getDataSourceSettings putDataSourceSettings

Properties

clearCache: typeof clearCache

Clears the cache for data-sources api requests.

getDataSourceApiSpecs: typeof getDataSourceApiSpecs

Get 'connectionProperties' for a given datasource

getDataSourceApiSpecs(
  "rest"
)

Datasource ID

GetDataSourceApiSpecsHttpError

getDataSourceGateways: typeof getDataSourceGateways

Get list available gateway ID's for a given datasource

getDataSourceGateways(
  "rest",
  {
    forceRefresh: true
  }
)

Datasource ID

an object with query parameters

GetDataSourceGatewaysHttpError

getDataSources: typeof getDataSources

Gets the list of data sources available on the node.

getDataSources(
  {
    dataSourceId: "rest",
    detail: true,
    includeDisabled: true,
    includeui: true
  }
)

an object with query parameters

GetDataSourcesHttpError

getDataSourceSettings: typeof getDataSourceSettings

Retrieves the settings for a data source.

getDataSourceSettings(
  "rest"
)

Datasource ID

GetDataSourceSettingsHttpError

putDataSourceSettings: typeof putDataSourceSettings

Updates the settings for a data source.

Datasource ID

Param: body

an object with the body content

PutDataSourceSettingsHttpError

Settings

Member Visibility

On This Page

Properties