Create a service client
- Last UpdatedJun 19, 2025
- 1 minute read
- Engineering
- Integration Service 4.0
- Integrators
To make a request to an AVEVA Integration Service Data API, you must first instantiate a AVEVA Integration Service client by using the static factory method
public static T CreateDataApiClient<T>(string host, AuthenticationType authType, int waitingTimeInMinutesForLiveData, string token, CancellationTokenSource hubCancellationToken)
Host (Required): In this placeholder user has to pass DATA API URL
|
Type |
String |
|---|---|
|
Position: |
Named |
|
Default value: |
None |
|
Required: |
True |
AuthenticationType (Optional): In this placeholder user has to type of authentication going to use in DATA API.
|
Type: |
Enum |
|---|---|
|
Position: |
Named |
|
Default value: |
Authentication.NTLM |
|
Required: |
False |
|
Accepted Values |
Authentication.NTLM, Authentication.Connect |
WaitingTimeInMinutesForLiveData (Optional): This placeholder will be used as waiting time to keep client to wait for the response from DATA API (In case of Adhoc request).
Note: Time is in minutes.
|
Type: |
Integer |
|---|---|
|
Position: |
Named |
|
Default value: |
60 |
|
Required: |
False |
Token (Optional): In this placeholder user has to pass the connect token to DATA API in case of connect authentication type
|
Type: |
String |
|---|---|
|
Position: |
Named |
|
Default value: |
Empty |
|
Required: |
False |
HubCancellationToken (Optional): In this placeholder user has to pass cancellation token which internally used to kill the waiting task of SDK to receive the response from DATA API.
|
Type: |
CancellationTokenSource |
|---|---|
|
Position: |
Named |
|
Default value: |
null |
|
Required: |
False |
By creating an Http Client to retrieve the data
Creating an Http Client and pass it as parameter to the method CreateDataApiClient of DataApiClientFactory. The factory method CreateDataApiClient<T> is a generic method.
var engineeringDataClient = DataApiHttpClientFactory.CreateDataApiHttpClient<EngineeringHttpClient>(client, host);