Opc.Ua.WebApi.Api.DefaultApi

All URIs are relative to http://localhost:4840

Method	HTTP request	Description
ActivateSession	POST /activatesession
Browse	POST /browse
BrowseNext	POST /browsenext
Call	POST /call
Cancel	POST /cancel
CloseSession	POST /closesession
CreateMonitoredItems	POST /createmonitoreditems
CreateSession	POST /createsession
CreateSubscription	POST /createsubscription
DeleteMonitoredItems	POST /deletemonitoreditems
DeleteSubscriptions	POST /deletesubscriptions
FindServers	POST /findservers
GetEndpoints	POST /getendpoints
HistoryRead	POST /historyread
HistoryUpdate	POST /historyupdate
ModifyMonitoredItems	POST /modifymonitoreditems
ModifySubscription	POST /modifysubscription
Publish	POST /publish
Read	POST /read
RegisterNodes	POST /registernodes
Republish	POST /republish
SetMonitoringMode	POST /setmonitoringmode
SetPublishingMode	POST /setpublishingmode
SetTriggering	POST /settriggering
TransferSubscriptions	POST /transfersubscriptions
TranslateBrowsePathsToNodeIds	POST /translate
UnregisterNodes	POST /unregisternodes
Write	POST /write

ActivateSession

ActivateSessionResponse ActivateSession (ActivateSessionRequest activateSessionRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class ActivateSessionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var activateSessionRequest = new ActivateSessionRequest(); // ActivateSessionRequest | ActivateSessionRequestMessage (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);
            }
        }
    }
}

Using the ActivateSessionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ActivateSessionResponse> response = apiInstance.ActivateSessionWithHttpInfo(activateSessionRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.ActivateSessionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
activateSessionRequest	ActivateSessionRequest	ActivateSessionRequestMessage	[optional]

Return type

ActivateSessionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ActivateSessionResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Browse

BrowseResponse Browse (BrowseRequest browseRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class BrowseExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var browseRequest = new BrowseRequest(); // BrowseRequest | BrowseRequestMessage (optional) 

            try
            {
                BrowseResponse result = apiInstance.Browse(browseRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Browse: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the BrowseWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<BrowseResponse> response = apiInstance.BrowseWithHttpInfo(browseRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.BrowseWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
browseRequest	BrowseRequest	BrowseRequestMessage	[optional]

Return type

BrowseResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	BrowseResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BrowseNext

BrowseNextResponse BrowseNext (BrowseNextRequest browseNextRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class BrowseNextExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var browseNextRequest = new BrowseNextRequest(); // BrowseNextRequest | BrowseNextRequestMessage (optional) 

            try
            {
                BrowseNextResponse result = apiInstance.BrowseNext(browseNextRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.BrowseNext: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the BrowseNextWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<BrowseNextResponse> response = apiInstance.BrowseNextWithHttpInfo(browseNextRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.BrowseNextWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
browseNextRequest	BrowseNextRequest	BrowseNextRequestMessage	[optional]

Return type

BrowseNextResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	BrowseNextResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Call

CallResponse Call (CallRequest callRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class CallExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var callRequest = new CallRequest(); // CallRequest | CallRequestMessage (optional) 

            try
            {
                CallResponse result = apiInstance.Call(callRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Call: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CallWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<CallResponse> response = apiInstance.CallWithHttpInfo(callRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.CallWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
callRequest	CallRequest	CallRequestMessage	[optional]

Return type

CallResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	CallResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Cancel

CancelResponse Cancel (CancelRequest cancelRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class CancelExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var cancelRequest = new CancelRequest(); // CancelRequest | CancelRequestMessage (optional) 

            try
            {
                CancelResponse result = apiInstance.Cancel(cancelRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Cancel: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CancelWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<CancelResponse> response = apiInstance.CancelWithHttpInfo(cancelRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.CancelWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
cancelRequest	CancelRequest	CancelRequestMessage	[optional]

Return type

CancelResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	CancelResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CloseSession

CloseSessionResponse CloseSession (CloseSessionRequest closeSessionRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class CloseSessionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var closeSessionRequest = new CloseSessionRequest(); // CloseSessionRequest | CloseSessionRequestMessage (optional) 

            try
            {
                CloseSessionResponse result = apiInstance.CloseSession(closeSessionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.CloseSession: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CloseSessionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<CloseSessionResponse> response = apiInstance.CloseSessionWithHttpInfo(closeSessionRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.CloseSessionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
closeSessionRequest	CloseSessionRequest	CloseSessionRequestMessage	[optional]

Return type

CloseSessionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	CloseSessionResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateMonitoredItems

CreateMonitoredItemsResponse CreateMonitoredItems (CreateMonitoredItemsRequest createMonitoredItemsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class CreateMonitoredItemsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var createMonitoredItemsRequest = new CreateMonitoredItemsRequest(); // CreateMonitoredItemsRequest | CreateMonitoredItemsRequestMessage (optional) 

            try
            {
                CreateMonitoredItemsResponse result = apiInstance.CreateMonitoredItems(createMonitoredItemsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.CreateMonitoredItems: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateMonitoredItemsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<CreateMonitoredItemsResponse> response = apiInstance.CreateMonitoredItemsWithHttpInfo(createMonitoredItemsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.CreateMonitoredItemsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
createMonitoredItemsRequest	CreateMonitoredItemsRequest	CreateMonitoredItemsRequestMessage	[optional]

Return type

CreateMonitoredItemsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	CreateMonitoredItemsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSession

CreateSessionResponse CreateSession (CreateSessionRequest createSessionRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class CreateSessionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var createSessionRequest = new CreateSessionRequest(); // CreateSessionRequest | CreateSessionRequestMessage (optional) 

            try
            {
                CreateSessionResponse result = apiInstance.CreateSession(createSessionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.CreateSession: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateSessionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<CreateSessionResponse> response = apiInstance.CreateSessionWithHttpInfo(createSessionRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.CreateSessionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
createSessionRequest	CreateSessionRequest	CreateSessionRequestMessage	[optional]

Return type

CreateSessionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	CreateSessionResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateSubscription

CreateSubscriptionResponse CreateSubscription (CreateSubscriptionRequest createSubscriptionRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class CreateSubscriptionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var createSubscriptionRequest = new CreateSubscriptionRequest(); // CreateSubscriptionRequest | CreateSubscriptionRequestMessage (optional) 

            try
            {
                CreateSubscriptionResponse result = apiInstance.CreateSubscription(createSubscriptionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.CreateSubscription: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateSubscriptionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<CreateSubscriptionResponse> response = apiInstance.CreateSubscriptionWithHttpInfo(createSubscriptionRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.CreateSubscriptionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
createSubscriptionRequest	CreateSubscriptionRequest	CreateSubscriptionRequestMessage	[optional]

Return type

CreateSubscriptionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	CreateSubscriptionResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMonitoredItems

DeleteMonitoredItemsResponse DeleteMonitoredItems (DeleteMonitoredItemsRequest deleteMonitoredItemsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class DeleteMonitoredItemsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var deleteMonitoredItemsRequest = new DeleteMonitoredItemsRequest(); // DeleteMonitoredItemsRequest | DeleteMonitoredItemsRequestMessage (optional) 

            try
            {
                DeleteMonitoredItemsResponse result = apiInstance.DeleteMonitoredItems(deleteMonitoredItemsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.DeleteMonitoredItems: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteMonitoredItemsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<DeleteMonitoredItemsResponse> response = apiInstance.DeleteMonitoredItemsWithHttpInfo(deleteMonitoredItemsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.DeleteMonitoredItemsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
deleteMonitoredItemsRequest	DeleteMonitoredItemsRequest	DeleteMonitoredItemsRequestMessage	[optional]

Return type

DeleteMonitoredItemsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	DeleteMonitoredItemsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSubscriptions

DeleteSubscriptionsResponse DeleteSubscriptions (DeleteSubscriptionsRequest deleteSubscriptionsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class DeleteSubscriptionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var deleteSubscriptionsRequest = new DeleteSubscriptionsRequest(); // DeleteSubscriptionsRequest | DeleteSubscriptionsRequestMessage (optional) 

            try
            {
                DeleteSubscriptionsResponse result = apiInstance.DeleteSubscriptions(deleteSubscriptionsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.DeleteSubscriptions: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteSubscriptionsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<DeleteSubscriptionsResponse> response = apiInstance.DeleteSubscriptionsWithHttpInfo(deleteSubscriptionsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.DeleteSubscriptionsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
deleteSubscriptionsRequest	DeleteSubscriptionsRequest	DeleteSubscriptionsRequestMessage	[optional]

Return type

DeleteSubscriptionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	DeleteSubscriptionsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindServers

FindServersResponse FindServers (FindServersRequest findServersRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class FindServersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var findServersRequest = new FindServersRequest(); // FindServersRequest | FindServersRequestMessage (optional) 

            try
            {
                FindServersResponse result = apiInstance.FindServers(findServersRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.FindServers: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the FindServersWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<FindServersResponse> response = apiInstance.FindServersWithHttpInfo(findServersRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.FindServersWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
findServersRequest	FindServersRequest	FindServersRequestMessage	[optional]

Return type

FindServersResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	FindServersResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEndpoints

GetEndpointsResponse GetEndpoints (GetEndpointsRequest getEndpointsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class GetEndpointsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var getEndpointsRequest = new GetEndpointsRequest(); // GetEndpointsRequest | GetEndpointsRequestMessage (optional) 

            try
            {
                GetEndpointsResponse result = apiInstance.GetEndpoints(getEndpointsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.GetEndpoints: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetEndpointsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<GetEndpointsResponse> response = apiInstance.GetEndpointsWithHttpInfo(getEndpointsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.GetEndpointsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
getEndpointsRequest	GetEndpointsRequest	GetEndpointsRequestMessage	[optional]

Return type

GetEndpointsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	GetEndpointsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HistoryRead

HistoryReadResponse HistoryRead (HistoryReadRequest historyReadRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class HistoryReadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var historyReadRequest = new HistoryReadRequest(); // HistoryReadRequest | HistoryReadRequestMessage (optional) 

            try
            {
                HistoryReadResponse result = apiInstance.HistoryRead(historyReadRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.HistoryRead: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the HistoryReadWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<HistoryReadResponse> response = apiInstance.HistoryReadWithHttpInfo(historyReadRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.HistoryReadWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
historyReadRequest	HistoryReadRequest	HistoryReadRequestMessage	[optional]

Return type

HistoryReadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HistoryReadResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HistoryUpdate

HistoryUpdateResponse HistoryUpdate (HistoryUpdateRequest historyUpdateRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class HistoryUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var historyUpdateRequest = new HistoryUpdateRequest(); // HistoryUpdateRequest | HistoryUpdateRequestMessage (optional) 

            try
            {
                HistoryUpdateResponse result = apiInstance.HistoryUpdate(historyUpdateRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.HistoryUpdate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the HistoryUpdateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<HistoryUpdateResponse> response = apiInstance.HistoryUpdateWithHttpInfo(historyUpdateRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.HistoryUpdateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
historyUpdateRequest	HistoryUpdateRequest	HistoryUpdateRequestMessage	[optional]

Return type

HistoryUpdateResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HistoryUpdateResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyMonitoredItems

ModifyMonitoredItemsResponse ModifyMonitoredItems (ModifyMonitoredItemsRequest modifyMonitoredItemsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class ModifyMonitoredItemsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var modifyMonitoredItemsRequest = new ModifyMonitoredItemsRequest(); // ModifyMonitoredItemsRequest | ModifyMonitoredItemsRequestMessage (optional) 

            try
            {
                ModifyMonitoredItemsResponse result = apiInstance.ModifyMonitoredItems(modifyMonitoredItemsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.ModifyMonitoredItems: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifyMonitoredItemsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ModifyMonitoredItemsResponse> response = apiInstance.ModifyMonitoredItemsWithHttpInfo(modifyMonitoredItemsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.ModifyMonitoredItemsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
modifyMonitoredItemsRequest	ModifyMonitoredItemsRequest	ModifyMonitoredItemsRequestMessage	[optional]

Return type

ModifyMonitoredItemsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ModifyMonitoredItemsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifySubscription

ModifySubscriptionResponse ModifySubscription (ModifySubscriptionRequest modifySubscriptionRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class ModifySubscriptionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var modifySubscriptionRequest = new ModifySubscriptionRequest(); // ModifySubscriptionRequest | ModifySubscriptionRequestMessage (optional) 

            try
            {
                ModifySubscriptionResponse result = apiInstance.ModifySubscription(modifySubscriptionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.ModifySubscription: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ModifySubscriptionWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ModifySubscriptionResponse> response = apiInstance.ModifySubscriptionWithHttpInfo(modifySubscriptionRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.ModifySubscriptionWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
modifySubscriptionRequest	ModifySubscriptionRequest	ModifySubscriptionRequestMessage	[optional]

Return type

ModifySubscriptionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ModifySubscriptionResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Publish

PublishResponse Publish (PublishRequest publishRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class PublishExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var publishRequest = new PublishRequest(); // PublishRequest | PublishRequestMessage (optional) 

            try
            {
                PublishResponse result = apiInstance.Publish(publishRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Publish: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PublishWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<PublishResponse> response = apiInstance.PublishWithHttpInfo(publishRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.PublishWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
publishRequest	PublishRequest	PublishRequestMessage	[optional]

Return type

PublishResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PublishResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Read

ReadResponse Read (ReadRequest readRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class ReadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var readRequest = new ReadRequest(); // ReadRequest | ReadRequestMessage (optional) 

            try
            {
                ReadResponse result = apiInstance.Read(readRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Read: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ReadWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ReadResponse> response = apiInstance.ReadWithHttpInfo(readRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.ReadWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
readRequest	ReadRequest	ReadRequestMessage	[optional]

Return type

ReadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ReadResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterNodes

RegisterNodesResponse RegisterNodes (RegisterNodesRequest registerNodesRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class RegisterNodesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var registerNodesRequest = new RegisterNodesRequest(); // RegisterNodesRequest | RegisterNodesRequestMessage (optional) 

            try
            {
                RegisterNodesResponse result = apiInstance.RegisterNodes(registerNodesRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.RegisterNodes: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RegisterNodesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<RegisterNodesResponse> response = apiInstance.RegisterNodesWithHttpInfo(registerNodesRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.RegisterNodesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
registerNodesRequest	RegisterNodesRequest	RegisterNodesRequestMessage	[optional]

Return type

RegisterNodesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	RegisterNodesResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Republish

RepublishResponse Republish (RepublishRequest republishRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class RepublishExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var republishRequest = new RepublishRequest(); // RepublishRequest | RepublishRequestMessage (optional) 

            try
            {
                RepublishResponse result = apiInstance.Republish(republishRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Republish: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RepublishWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<RepublishResponse> response = apiInstance.RepublishWithHttpInfo(republishRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.RepublishWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
republishRequest	RepublishRequest	RepublishRequestMessage	[optional]

Return type

RepublishResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	RepublishResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetMonitoringMode

SetMonitoringModeResponse SetMonitoringMode (SetMonitoringModeRequest setMonitoringModeRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class SetMonitoringModeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var setMonitoringModeRequest = new SetMonitoringModeRequest(); // SetMonitoringModeRequest | SetMonitoringModeRequestMessage (optional) 

            try
            {
                SetMonitoringModeResponse result = apiInstance.SetMonitoringMode(setMonitoringModeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.SetMonitoringMode: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SetMonitoringModeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<SetMonitoringModeResponse> response = apiInstance.SetMonitoringModeWithHttpInfo(setMonitoringModeRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.SetMonitoringModeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
setMonitoringModeRequest	SetMonitoringModeRequest	SetMonitoringModeRequestMessage	[optional]

Return type

SetMonitoringModeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	SetMonitoringModeResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPublishingMode

SetPublishingModeResponse SetPublishingMode (SetPublishingModeRequest setPublishingModeRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class SetPublishingModeExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var setPublishingModeRequest = new SetPublishingModeRequest(); // SetPublishingModeRequest | SetPublishingModeRequestMessage (optional) 

            try
            {
                SetPublishingModeResponse result = apiInstance.SetPublishingMode(setPublishingModeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.SetPublishingMode: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SetPublishingModeWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<SetPublishingModeResponse> response = apiInstance.SetPublishingModeWithHttpInfo(setPublishingModeRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.SetPublishingModeWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
setPublishingModeRequest	SetPublishingModeRequest	SetPublishingModeRequestMessage	[optional]

Return type

SetPublishingModeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	SetPublishingModeResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetTriggering

SetTriggeringResponse SetTriggering (SetTriggeringRequest setTriggeringRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class SetTriggeringExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var setTriggeringRequest = new SetTriggeringRequest(); // SetTriggeringRequest | SetTriggeringRequestMessage (optional) 

            try
            {
                SetTriggeringResponse result = apiInstance.SetTriggering(setTriggeringRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.SetTriggering: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the SetTriggeringWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<SetTriggeringResponse> response = apiInstance.SetTriggeringWithHttpInfo(setTriggeringRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.SetTriggeringWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
setTriggeringRequest	SetTriggeringRequest	SetTriggeringRequestMessage	[optional]

Return type

SetTriggeringResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	SetTriggeringResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TransferSubscriptions

TransferSubscriptionsResponse TransferSubscriptions (TransferSubscriptionsRequest transferSubscriptionsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class TransferSubscriptionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var transferSubscriptionsRequest = new TransferSubscriptionsRequest(); // TransferSubscriptionsRequest | TransferSubscriptionsRequestMessage (optional) 

            try
            {
                TransferSubscriptionsResponse result = apiInstance.TransferSubscriptions(transferSubscriptionsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.TransferSubscriptions: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TransferSubscriptionsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<TransferSubscriptionsResponse> response = apiInstance.TransferSubscriptionsWithHttpInfo(transferSubscriptionsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.TransferSubscriptionsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
transferSubscriptionsRequest	TransferSubscriptionsRequest	TransferSubscriptionsRequestMessage	[optional]

Return type

TransferSubscriptionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	TransferSubscriptionsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TranslateBrowsePathsToNodeIds

TranslateBrowsePathsToNodeIdsResponse TranslateBrowsePathsToNodeIds (TranslateBrowsePathsToNodeIdsRequest translateBrowsePathsToNodeIdsRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class TranslateBrowsePathsToNodeIdsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var translateBrowsePathsToNodeIdsRequest = new TranslateBrowsePathsToNodeIdsRequest(); // TranslateBrowsePathsToNodeIdsRequest | TranslateBrowsePathsToNodeIdsRequestMessage (optional) 

            try
            {
                TranslateBrowsePathsToNodeIdsResponse result = apiInstance.TranslateBrowsePathsToNodeIds(translateBrowsePathsToNodeIdsRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.TranslateBrowsePathsToNodeIds: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TranslateBrowsePathsToNodeIdsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<TranslateBrowsePathsToNodeIdsResponse> response = apiInstance.TranslateBrowsePathsToNodeIdsWithHttpInfo(translateBrowsePathsToNodeIdsRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.TranslateBrowsePathsToNodeIdsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
translateBrowsePathsToNodeIdsRequest	TranslateBrowsePathsToNodeIdsRequest	TranslateBrowsePathsToNodeIdsRequestMessage	[optional]

Return type

TranslateBrowsePathsToNodeIdsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	TranslateBrowsePathsToNodeIdsResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnregisterNodes

UnregisterNodesResponse UnregisterNodes (UnregisterNodesRequest unregisterNodesRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class UnregisterNodesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var unregisterNodesRequest = new UnregisterNodesRequest(); // UnregisterNodesRequest | UnregisterNodesRequestMessage (optional) 

            try
            {
                UnregisterNodesResponse result = apiInstance.UnregisterNodes(unregisterNodesRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.UnregisterNodes: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UnregisterNodesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<UnregisterNodesResponse> response = apiInstance.UnregisterNodesWithHttpInfo(unregisterNodesRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.UnregisterNodesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
unregisterNodesRequest	UnregisterNodesRequest	UnregisterNodesRequestMessage	[optional]

Return type

UnregisterNodesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	UnregisterNodesResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Write

WriteResponse Write (WriteRequest writeRequest = null)

Example

using System.Collections.Generic;
using System.Diagnostics;
using Opc.Ua.WebApi.Api;
using Opc.Ua.WebApi.Client;
using Opc.Ua.WebApi.Model;

namespace Example
{
    public class WriteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "http://localhost:4840";
            var apiInstance = new DefaultApi(config);
            var writeRequest = new WriteRequest(); // WriteRequest | WriteRequestMessage (optional) 

            try
            {
                WriteResponse result = apiInstance.Write(writeRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DefaultApi.Write: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the WriteWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<WriteResponse> response = apiInstance.WriteWithHttpInfo(writeRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling DefaultApi.WriteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
writeRequest	WriteRequest	WriteRequestMessage	[optional]

Return type

WriteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	WriteResponseMessage	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

Opc.Ua.WebApi.Api.DefaultApi

ActivateSession

Example

Using the ActivateSessionWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Browse

Example

Using the BrowseWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

BrowseNext

Example

Using the BrowseNextWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Call

Example

Using the CallWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Cancel

Example

Using the CancelWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CloseSession

Example

Using the CloseSessionWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateMonitoredItems

Example

Using the CreateMonitoredItemsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateSession

Example

Using the CreateSessionWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

CreateSubscription

Example

Using the CreateSubscriptionWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteMonitoredItems