Ingest

The Ingest API is intended to provide an SDK for client applications installed at customer locations to ingest data from local data sources.

Class

class ClientSDK.Ingest

Child Classes

• IngestClient

• IngestAgent

• IngestAgentConfiguration

Methods

GetClientByIdAsync

Retrieves the IngestClient by the Twin Reference Id

• Required Role(s): Any

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

ClientSDK.Ingest.GetClientByIdAsync(string ingestClientId)

Parameters

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

Returns

An IngestClient object that contains all of the configuration for the client.

Return type

Task<IngestClient>

RegisterClientAsync

Creates a Digital Twin for the Ingest Client and does minimal setup

• Required Role(s): Any

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

ClientSDK.Ingest.RegisterClientAsync(string ingestClientName)

Parameters

ingestClientName (string) – The name of the ingest client.

Returns

An IngestClient object that contains all of the configuration for the client.

Return type

Task<IngestClient>

GetAllClientsAsync

Retrieves a collection of all IngestClients the user has rights to retrieve

• Required Role(s): Any

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

ClientSDK.Ingest.GetAllClientsAsync()

Returns

A collection of all of the ingest clients the user has access.

Return type

Task<List<IngestClient>>