# opcua-webapi-dotnet **Repository Path**: hangfire/opcua-webapi-dotnet ## Basic Information - **Project Name**: opcua-webapi-dotnet - **Description**: No description available - **Primary Language**: C# - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-12-09 - **Last Updated**: 2025-12-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Opc.Ua.WebApi - the C# library for the OPC UA Web API Provides simple HTTPS based access to an OPC UA server. This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.05.4 - SDK version: 15.6.0 - Generator version: 7.15.0 - Build package: org.openapitools.codegen.languages.CSharpClientCodegen ## Frameworks supported - .NET Core >=1.0 - .NET Framework >=4.6 - Mono/Xamarin >=vNext ## Dependencies - [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later - [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later - [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages: ``` Install-Package Newtonsoft.Json Install-Package JsonSubTypes Install-Package System.ComponentModel.Annotations ``` ## Installation Generate the DLL using your preferred tool (e.g. `dotnet build`) Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces: ```csharp using Opc.Ua.WebApi.Api; using Opc.Ua.WebApi.Client; using Opc.Ua.WebApi.Model; ``` ## Usage To use the API client with a HTTP proxy, setup a `System.Net.WebProxy` ```csharp Configuration c = new Configuration(); System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/"); webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials; c.Proxy = webProxy; ``` ### Connections Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method. To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see [here](https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#issues-with-the-original-httpclient-class-available-in-net) for details). To use your own HttpClient instance just pass it to the ApiClass constructor. ```csharp HttpClientHandler yourHandler = new HttpClientHandler(); HttpClient yourHttpClient = new HttpClient(yourHandler); var api = new YourApiClass(yourHttpClient, yourHandler); ``` If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory. ```csharp HttpClient yourHttpClient = new HttpClient(); var api = new YourApiClass(yourHttpClient); ``` You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available. Here an example of DI setup in a sample web project: ```csharp services.AddHttpClient(httpClient => new PetApi(httpClient)); ``` ## Getting Started ```csharp using System.Collections.Generic; using System.Diagnostics; using System.Net.Http; using Opc.Ua.WebApi.Api; using Opc.Ua.WebApi.Client; using Opc.Ua.WebApi.Model; namespace Example { public class Example { public static void Main() { Configuration config = new Configuration(); config.BasePath = "http://localhost:4840"; // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes HttpClient httpClient = new HttpClient(); HttpClientHandler httpClientHandler = new HttpClientHandler(); var apiInstance = new DefaultApi(httpClient, config, httpClientHandler); var activateSessionRequest = new ActivateSessionRequest(); // ActivateSessionRequest | [Link to specification](https://reference.opcfoundation.org/v105/Core/docs/Part4/5.7.3/#5.7.3.2). (optional) try { ActivateSessionResponse result = apiInstance.ActivateSession(activateSessionRequest); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling DefaultApi.ActivateSession: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } } ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost:4840* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *DefaultApi* | [**ActivateSession**](docs/DefaultApi.md#activatesession) | **POST** /activatesession | *DefaultApi* | [**Browse**](docs/DefaultApi.md#browse) | **POST** /browse | *DefaultApi* | [**BrowseNext**](docs/DefaultApi.md#browsenext) | **POST** /browsenext | *DefaultApi* | [**Call**](docs/DefaultApi.md#call) | **POST** /call | *DefaultApi* | [**Cancel**](docs/DefaultApi.md#cancel) | **POST** /cancel | *DefaultApi* | [**CloseSession**](docs/DefaultApi.md#closesession) | **POST** /closesession | *DefaultApi* | [**CreateMonitoredItems**](docs/DefaultApi.md#createmonitoreditems) | **POST** /createmonitoreditems | *DefaultApi* | [**CreateSession**](docs/DefaultApi.md#createsession) | **POST** /createsession | *DefaultApi* | [**CreateSubscription**](docs/DefaultApi.md#createsubscription) | **POST** /createsubscription | *DefaultApi* | [**DeleteMonitoredItems**](docs/DefaultApi.md#deletemonitoreditems) | **POST** /deletemonitoreditems | *DefaultApi* | [**DeleteSubscriptions**](docs/DefaultApi.md#deletesubscriptions) | **POST** /deletesubscriptions | *DefaultApi* | [**FindServers**](docs/DefaultApi.md#findservers) | **POST** /findservers | *DefaultApi* | [**GetEndpoints**](docs/DefaultApi.md#getendpoints) | **POST** /getendpoints | *DefaultApi* | [**HistoryRead**](docs/DefaultApi.md#historyread) | **POST** /historyread | *DefaultApi* | [**HistoryUpdate**](docs/DefaultApi.md#historyupdate) | **POST** /historyupdate | *DefaultApi* | [**ModifyMonitoredItems**](docs/DefaultApi.md#modifymonitoreditems) | **POST** /modifymonitoreditems | *DefaultApi* | [**ModifySubscription**](docs/DefaultApi.md#modifysubscription) | **POST** /modifysubscription | *DefaultApi* | [**Publish**](docs/DefaultApi.md#publish) | **POST** /publish | *DefaultApi* | [**Read**](docs/DefaultApi.md#read) | **POST** /read | *DefaultApi* | [**RegisterNodes**](docs/DefaultApi.md#registernodes) | **POST** /registernodes | *DefaultApi* | [**Republish**](docs/DefaultApi.md#republish) | **POST** /republish | *DefaultApi* | [**SetMonitoringMode**](docs/DefaultApi.md#setmonitoringmode) | **POST** /setmonitoringmode | *DefaultApi* | [**SetPublishingMode**](docs/DefaultApi.md#setpublishingmode) | **POST** /setpublishingmode | *DefaultApi* | [**SetTriggering**](docs/DefaultApi.md#settriggering) | **POST** /settriggering | *DefaultApi* | [**TransferSubscriptions**](docs/DefaultApi.md#transfersubscriptions) | **POST** /transfersubscriptions | *DefaultApi* | [**TranslateBrowsePathsToNodeIds**](docs/DefaultApi.md#translatebrowsepathstonodeids) | **POST** /translate | *DefaultApi* | [**UnregisterNodes**](docs/DefaultApi.md#unregisternodes) | **POST** /unregisternodes | *DefaultApi* | [**Write**](docs/DefaultApi.md#write) | **POST** /write | ## Documentation for Models - [Model.ActionMethodDataType](docs/ActionMethodDataType.md) - [Model.ActionState](docs/ActionState.md) - [Model.ActionTargetDataType](docs/ActionTargetDataType.md) - [Model.ActivateSessionRequest](docs/ActivateSessionRequest.md) - [Model.ActivateSessionResponse](docs/ActivateSessionResponse.md) - [Model.AggregateConfiguration](docs/AggregateConfiguration.md) - [Model.AggregateFilter](docs/AggregateFilter.md) - [Model.AggregateFilterResult](docs/AggregateFilterResult.md) - [Model.ApplicationDescription](docs/ApplicationDescription.md) - [Model.ApplicationType](docs/ApplicationType.md) - [Model.Argument](docs/Argument.md) - [Model.AttributeOperand](docs/AttributeOperand.md) - [Model.BrokerConnectionTransportDataType](docs/BrokerConnectionTransportDataType.md) - [Model.BrokerDataSetReaderTransportDataType](docs/BrokerDataSetReaderTransportDataType.md) - [Model.BrokerDataSetWriterTransportDataType](docs/BrokerDataSetWriterTransportDataType.md) - [Model.BrokerTransportQualityOfService](docs/BrokerTransportQualityOfService.md) - [Model.BrokerWriterGroupTransportDataType](docs/BrokerWriterGroupTransportDataType.md) - [Model.BrowseDescription](docs/BrowseDescription.md) - [Model.BrowseDirection](docs/BrowseDirection.md) - [Model.BrowseNextRequest](docs/BrowseNextRequest.md) - [Model.BrowseNextResponse](docs/BrowseNextResponse.md) - [Model.BrowsePath](docs/BrowsePath.md) - [Model.BrowsePathResult](docs/BrowsePathResult.md) - [Model.BrowsePathTarget](docs/BrowsePathTarget.md) - [Model.BrowseRequest](docs/BrowseRequest.md) - [Model.BrowseResponse](docs/BrowseResponse.md) - [Model.BrowseResult](docs/BrowseResult.md) - [Model.CallMethodRequest](docs/CallMethodRequest.md) - [Model.CallMethodResult](docs/CallMethodResult.md) - [Model.CallRequest](docs/CallRequest.md) - [Model.CallResponse](docs/CallResponse.md) - [Model.CancelRequest](docs/CancelRequest.md) - [Model.CancelResponse](docs/CancelResponse.md) - [Model.CloseSessionRequest](docs/CloseSessionRequest.md) - [Model.CloseSessionResponse](docs/CloseSessionResponse.md) - [Model.ConfigurationVersionDataType](docs/ConfigurationVersionDataType.md) - [Model.ContentFilter](docs/ContentFilter.md) - [Model.ContentFilterElement](docs/ContentFilterElement.md) - [Model.ContentFilterElementResult](docs/ContentFilterElementResult.md) - [Model.ContentFilterResult](docs/ContentFilterResult.md) - [Model.CreateMonitoredItemsRequest](docs/CreateMonitoredItemsRequest.md) - [Model.CreateMonitoredItemsResponse](docs/CreateMonitoredItemsResponse.md) - [Model.CreateSessionRequest](docs/CreateSessionRequest.md) - [Model.CreateSessionResponse](docs/CreateSessionResponse.md) - [Model.CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md) - [Model.CreateSubscriptionResponse](docs/CreateSubscriptionResponse.md) - [Model.DataChangeFilter](docs/DataChangeFilter.md) - [Model.DataChangeNotification](docs/DataChangeNotification.md) - [Model.DataChangeTrigger](docs/DataChangeTrigger.md) - [Model.DataSetFieldContentMaskBits](docs/DataSetFieldContentMaskBits.md) - [Model.DataSetFieldFlagsBits](docs/DataSetFieldFlagsBits.md) - [Model.DataSetMetaDataType](docs/DataSetMetaDataType.md) - [Model.DataSetReaderDataType](docs/DataSetReaderDataType.md) - [Model.DataSetWriterDataType](docs/DataSetWriterDataType.md) - [Model.DataTypeDescription](docs/DataTypeDescription.md) - [Model.DataTypeSchemaHeader](docs/DataTypeSchemaHeader.md) - [Model.DataValue](docs/DataValue.md) - [Model.Decimal](docs/Decimal.md) - [Model.DeleteMonitoredItemsRequest](docs/DeleteMonitoredItemsRequest.md) - [Model.DeleteMonitoredItemsResponse](docs/DeleteMonitoredItemsResponse.md) - [Model.DeleteSubscriptionsRequest](docs/DeleteSubscriptionsRequest.md) - [Model.DeleteSubscriptionsResponse](docs/DeleteSubscriptionsResponse.md) - [Model.DiagnosticInfo](docs/DiagnosticInfo.md) - [Model.EUInformation](docs/EUInformation.md) - [Model.ElementOperand](docs/ElementOperand.md) - [Model.EndpointDescription](docs/EndpointDescription.md) - [Model.EnumDefinition](docs/EnumDefinition.md) - [Model.EnumDescription](docs/EnumDescription.md) - [Model.EnumField](docs/EnumField.md) - [Model.EnumValueType](docs/EnumValueType.md) - [Model.EventFieldList](docs/EventFieldList.md) - [Model.EventFilter](docs/EventFilter.md) - [Model.EventFilterResult](docs/EventFilterResult.md) - [Model.EventNotificationList](docs/EventNotificationList.md) - [Model.ExtensionObject](docs/ExtensionObject.md) - [Model.FieldMetaData](docs/FieldMetaData.md) - [Model.FilterOperator](docs/FilterOperator.md) - [Model.FindServersRequest](docs/FindServersRequest.md) - [Model.FindServersResponse](docs/FindServersResponse.md) - [Model.GetEndpointsRequest](docs/GetEndpointsRequest.md) - [Model.GetEndpointsResponse](docs/GetEndpointsResponse.md) - [Model.HistoryData](docs/HistoryData.md) - [Model.HistoryEvent](docs/HistoryEvent.md) - [Model.HistoryEventFieldList](docs/HistoryEventFieldList.md) - [Model.HistoryModifiedData](docs/HistoryModifiedData.md) - [Model.HistoryReadRequest](docs/HistoryReadRequest.md) - [Model.HistoryReadResponse](docs/HistoryReadResponse.md) - [Model.HistoryReadResult](docs/HistoryReadResult.md) - [Model.HistoryReadValueId](docs/HistoryReadValueId.md) - [Model.HistoryUpdateRequest](docs/HistoryUpdateRequest.md) - [Model.HistoryUpdateResponse](docs/HistoryUpdateResponse.md) - [Model.HistoryUpdateResult](docs/HistoryUpdateResult.md) - [Model.HistoryUpdateType](docs/HistoryUpdateType.md) - [Model.IssuedIdentityToken](docs/IssuedIdentityToken.md) - [Model.JsonActionMetaDataMessage](docs/JsonActionMetaDataMessage.md) - [Model.JsonActionNetworkMessage](docs/JsonActionNetworkMessage.md) - [Model.JsonActionRequestMessage](docs/JsonActionRequestMessage.md) - [Model.JsonActionResponderMessage](docs/JsonActionResponderMessage.md) - [Model.JsonActionResponseMessage](docs/JsonActionResponseMessage.md) - [Model.JsonApplicationDescriptionMessage](docs/JsonApplicationDescriptionMessage.md) - [Model.JsonDataSetMessage](docs/JsonDataSetMessage.md) - [Model.JsonDataSetMessageContentMaskBits](docs/JsonDataSetMessageContentMaskBits.md) - [Model.JsonDataSetMetaDataMessage](docs/JsonDataSetMetaDataMessage.md) - [Model.JsonDataSetReaderMessageDataType](docs/JsonDataSetReaderMessageDataType.md) - [Model.JsonDataSetWriterMessageDataType](docs/JsonDataSetWriterMessageDataType.md) - [Model.JsonMessageType](docs/JsonMessageType.md) - [Model.JsonNetworkMessage](docs/JsonNetworkMessage.md) - [Model.JsonNetworkMessageContentMaskBits](docs/JsonNetworkMessageContentMaskBits.md) - [Model.JsonPubSubConnectionMessage](docs/JsonPubSubConnectionMessage.md) - [Model.JsonServerEndpointsMessage](docs/JsonServerEndpointsMessage.md) - [Model.JsonStatusMessage](docs/JsonStatusMessage.md) - [Model.JsonWriterGroupMessageDataType](docs/JsonWriterGroupMessageDataType.md) - [Model.KeyValuePair](docs/KeyValuePair.md) - [Model.LiteralOperand](docs/LiteralOperand.md) - [Model.LocalizedText](docs/LocalizedText.md) - [Model.Matrix](docs/Matrix.md) - [Model.MessageSecurityMode](docs/MessageSecurityMode.md) - [Model.ModificationInfo](docs/ModificationInfo.md) - [Model.ModifyMonitoredItemsRequest](docs/ModifyMonitoredItemsRequest.md) - [Model.ModifyMonitoredItemsResponse](docs/ModifyMonitoredItemsResponse.md) - [Model.ModifySubscriptionRequest](docs/ModifySubscriptionRequest.md) - [Model.ModifySubscriptionResponse](docs/ModifySubscriptionResponse.md) - [Model.MonitoredItemCreateRequest](docs/MonitoredItemCreateRequest.md) - [Model.MonitoredItemCreateResult](docs/MonitoredItemCreateResult.md) - [Model.MonitoredItemModifyRequest](docs/MonitoredItemModifyRequest.md) - [Model.MonitoredItemModifyResult](docs/MonitoredItemModifyResult.md) - [Model.MonitoredItemNotification](docs/MonitoredItemNotification.md) - [Model.MonitoringMode](docs/MonitoringMode.md) - [Model.MonitoringParameters](docs/MonitoringParameters.md) - [Model.NetworkAddressDataType](docs/NetworkAddressDataType.md) - [Model.NodeClass](docs/NodeClass.md) - [Model.NotificationMessage](docs/NotificationMessage.md) - [Model.PerformUpdateType](docs/PerformUpdateType.md) - [Model.PermissionTypeBits](docs/PermissionTypeBits.md) - [Model.PubSubConfiguration2DataType](docs/PubSubConfiguration2DataType.md) - [Model.PubSubConfigurationDataType](docs/PubSubConfigurationDataType.md) - [Model.PubSubConnectionDataType](docs/PubSubConnectionDataType.md) - [Model.PubSubGroupDataType](docs/PubSubGroupDataType.md) - [Model.PubSubKeyPushTargetDataType](docs/PubSubKeyPushTargetDataType.md) - [Model.PubSubState](docs/PubSubState.md) - [Model.PublishRequest](docs/PublishRequest.md) - [Model.PublishResponse](docs/PublishResponse.md) - [Model.PublishedDataSetDataType](docs/PublishedDataSetDataType.md) - [Model.Range](docs/Range.md) - [Model.ReadAnnotationDataDetails](docs/ReadAnnotationDataDetails.md) - [Model.ReadAtTimeDetails](docs/ReadAtTimeDetails.md) - [Model.ReadEventDetails](docs/ReadEventDetails.md) - [Model.ReadEventDetails2](docs/ReadEventDetails2.md) - [Model.ReadProcessedDetails](docs/ReadProcessedDetails.md) - [Model.ReadRawModifiedDetails](docs/ReadRawModifiedDetails.md) - [Model.ReadRequest](docs/ReadRequest.md) - [Model.ReadResponse](docs/ReadResponse.md) - [Model.ReadValueId](docs/ReadValueId.md) - [Model.ReaderGroupDataType](docs/ReaderGroupDataType.md) - [Model.ReferenceDescription](docs/ReferenceDescription.md) - [Model.RegisterNodesRequest](docs/RegisterNodesRequest.md) - [Model.RegisterNodesResponse](docs/RegisterNodesResponse.md) - [Model.RelativePath](docs/RelativePath.md) - [Model.RelativePathElement](docs/RelativePathElement.md) - [Model.RepublishRequest](docs/RepublishRequest.md) - [Model.RepublishResponse](docs/RepublishResponse.md) - [Model.RequestHeader](docs/RequestHeader.md) - [Model.ResponseHeader](docs/ResponseHeader.md) - [Model.RolePermissionType](docs/RolePermissionType.md) - [Model.SecurityGroupDataType](docs/SecurityGroupDataType.md) - [Model.SetMonitoringModeRequest](docs/SetMonitoringModeRequest.md) - [Model.SetMonitoringModeResponse](docs/SetMonitoringModeResponse.md) - [Model.SetPublishingModeRequest](docs/SetPublishingModeRequest.md) - [Model.SetPublishingModeResponse](docs/SetPublishingModeResponse.md) - [Model.SetTriggeringRequest](docs/SetTriggeringRequest.md) - [Model.SetTriggeringResponse](docs/SetTriggeringResponse.md) - [Model.SignatureData](docs/SignatureData.md) - [Model.SignedSoftwareCertificate](docs/SignedSoftwareCertificate.md) - [Model.SimpleAttributeOperand](docs/SimpleAttributeOperand.md) - [Model.SimpleTypeDescription](docs/SimpleTypeDescription.md) - [Model.StandaloneSubscribedDataSetDataType](docs/StandaloneSubscribedDataSetDataType.md) - [Model.StatusChangeNotification](docs/StatusChangeNotification.md) - [Model.StatusCode](docs/StatusCode.md) - [Model.StructureDefinition](docs/StructureDefinition.md) - [Model.StructureDescription](docs/StructureDescription.md) - [Model.StructureField](docs/StructureField.md) - [Model.StructureType](docs/StructureType.md) - [Model.SubscriptionAcknowledgement](docs/SubscriptionAcknowledgement.md) - [Model.TimestampsToReturn](docs/TimestampsToReturn.md) - [Model.TransferResult](docs/TransferResult.md) - [Model.TransferSubscriptionsRequest](docs/TransferSubscriptionsRequest.md) - [Model.TransferSubscriptionsResponse](docs/TransferSubscriptionsResponse.md) - [Model.TranslateBrowsePathsToNodeIdsRequest](docs/TranslateBrowsePathsToNodeIdsRequest.md) - [Model.TranslateBrowsePathsToNodeIdsResponse](docs/TranslateBrowsePathsToNodeIdsResponse.md) - [Model.UnregisterNodesRequest](docs/UnregisterNodesRequest.md) - [Model.UnregisterNodesResponse](docs/UnregisterNodesResponse.md) - [Model.UpdateDataDetails](docs/UpdateDataDetails.md) - [Model.UpdateEventDetails](docs/UpdateEventDetails.md) - [Model.UpdateStructureDataDetails](docs/UpdateStructureDataDetails.md) - [Model.UserIdentityToken](docs/UserIdentityToken.md) - [Model.UserNameIdentityToken](docs/UserNameIdentityToken.md) - [Model.UserTokenPolicy](docs/UserTokenPolicy.md) - [Model.UserTokenType](docs/UserTokenType.md) - [Model.Variant](docs/Variant.md) - [Model.ViewDescription](docs/ViewDescription.md) - [Model.WriteRequest](docs/WriteRequest.md) - [Model.WriteResponse](docs/WriteResponse.md) - [Model.WriteValue](docs/WriteValue.md) - [Model.WriterGroupDataType](docs/WriterGroupDataType.md) - [Model.X509IdentityToken](docs/X509IdentityToken.md) ## Documentation for Authorization Endpoints do not require authorization.