Resources

Certificates


This section lists the certificate APi provided by OPC Publisher providing all public and private key infrastructure (PKI) related API methods.


The method name for all transports other than HTTP (which uses the shown HTTP methods and resource uris) is the name of the subsection header. To use the version specific method append “_V1” or “_V2” to the method name.

AddTrustedHttpsCertificateAsync

POST /v2/pki/https/certs
Description

Add a certificate chain to the trusted https store. The certificate is provided as a concatenated set of certificates with the first the one to add, and the remainder the issuer chain.

Parameters
Type Name Description Schema
Body body
required		 The certificate chain. string (byte)
Responses
HTTP Code Description Schema
200 Success No Content
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack

ApproveRejectedCertificate

POST /v2/pki/rejected/certs/{thumbprint}/approve
Description

Move a rejected certificate from the rejected folder to the trusted folder on the publisher.

Parameters
Type Name Description Schema
Path thumbprint
required		 The thumbprint of the certificate to trust. string
Responses
HTTP Code Description Schema
200 Success No Content

AddCertificateChain

POST /v2/pki/trusted/certs
Description

Add a certificate chain to the specified store. The certificate is provided as a concatenated asn encoded set of certificates with the first the one to add, and the remainder the issuer chain.

Parameters
Type Name Description Schema
Body body
required		 The certificate chain. string (byte)
Responses
HTTP Code Description Schema
200 Success No Content
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack

RemoveAll

DELETE /v2/pki/{store}
Description

Remove all certificates and revocation lists from the specified store.

Parameters
Type Name Description Schema
Path store
required		 The store to add the certificate to enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Responses
HTTP Code Description Schema
200 Success No Content

ListCertificates

GET /v2/pki/{store}/certs
Description

Get the certificates in the specified certificate store

Parameters
Type Name Description Schema
Path store
required		 The store to enumerate enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Responses
HTTP Code Description Schema
200 Success < X509CertificateModel > array
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

AddCertificate

PATCH /v2/pki/{store}/certs
Description

Add a certificate to the specified store. The certificate is provided as a pfx/pkcs12 optionally password protected blob.

Parameters
Type Name Description Schema
Path store
required		 The store to add the certificate to enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Query password
optional		 The optional password of the pfx string
Body body
required		 The pfx encoded certificate. string (byte)
Responses
HTTP Code Description Schema
200 Success No Content
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack

RemoveCertificate

DELETE /v2/pki/{store}/certs/{thumbprint}
Description

Remove a certificate with the provided thumbprint from the specified store.

Parameters
Type Name Description Schema
Path store
required		 The store to add the certificate to enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Path thumbprint
required		 The thumbprint of the certificate to delete. string
Responses
HTTP Code Description Schema
200 Success No Content

ListCertificateRevocationLists

GET /v2/pki/{store}/crls
Description

Get the certificates in the specified certificated store

Parameters
Type Name Description Schema
Path store
required		 The store to enumerate enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Responses
HTTP Code Description Schema
200 Success < string (byte) > array
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

RemoveCertificateRevocationList

DELETE /v2/pki/{store}/crls
Description

Remove a certificate revocation list from the specified store.

Parameters
Type Name Description Schema
Path store
required		 The store to add the certificate to enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Responses
HTTP Code Description Schema
200 Success No Content

AddCertificateRevocationList

PATCH /v2/pki/{store}/crls
Description

Add a certificate revocation list to the specified store. The certificate revocation list is provided as a der encoded blob.

Parameters
Type Name Description Schema
Path store
required		 The store to add the certificate to enum (Application, Rejected, Trusted, Https, User, Issuer, HttpsIssuer, UserIssuer)
Body body
required		 The pfx encoded certificate. string (byte)
Responses
HTTP Code Description Schema
200 Success No Content
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack

Configuration


This section contains the API to configure OPC Publisher.


The method name for all transports other than HTTP (which uses the shown HTTP methods and resource uris) is the name of the subsection header. To use the version specific method append “_V1” or “_V2” to the method name.

GetConfiguredEndpoints

GET /v2/configuration
Description

Get a list of nodes under a configured endpoint in the configuration. Further information is provided in the OPC Publisher documentation. configuration.

Parameters
Type Name Description Schema
Query IncludeNodes
optional		 Include nodes that make up the configuration boolean
Responses
HTTP Code Description Schema
200 Success GetConfiguredEndpointsResponseModel
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

SetConfiguredEndpoints

PUT /v2/configuration
Description

Enables clients to update the entire published nodes configuration in one call. This includes clearing the existing configuration. Further information is provided in the OPC Publisher documentation. configuration.

Parameters
Type Name Description Schema
Body body
required		 The new published nodes configuration SetConfiguredEndpointsRequestModel
Responses
HTTP Code Description Schema
200 Success No Content
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack

AddOrUpdateEndpoints

PATCH /v2/configuration
Description

Add or update endpoint configuration and nodes on a server. Further information is provided in the OPC Publisher documentation.

Parameters
Type Name Description Schema
Body body
required		 The parts of the configuration to add or update. < PublishedNodesEntryModel > array
Responses
HTTP Code Description Schema
200 Success PublishedNodesResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

PublishBulk

POST /v2/configuration/bulk
Description

Configure node values to publish and unpublish in bulk. The group field in the Connection Model can be used to specify a writer group identifier that will be used in the configuration entry that is created from it inside the OPC Publisher.

Parameters
Type Name Description Schema
Body body
required		 The nodes to publish or unpublish. PublishBulkRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success PublishBulkResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

GetDiagnosticInfo

POST /v2/configuration/diagnostics
Description

Get the list of diagnostics info for all dataset writers in the OPC Publisher at the point the call is received. Further information is provided in the OPC Publisher documentation.

Responses
HTTP Code Description Schema
200 Success < PublishDiagnosticInfoModel > array
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

GetConfiguredNodesOnEndpoint

POST /v2/configuration/endpoints/list/nodes
Description

Get the nodes of a published nodes entry object returned earlier from a call to GetConfiguredEndpoints. Further information is provided in the OPC Publisher documentation.

Parameters
Type Name Description Schema
Body body
required		 The entry model from a call to GetConfiguredEndpoints for which to gather the nodes. PublishedNodesEntryModel
Responses
HTTP Code Description Schema
200 Success GetConfiguredNodesOnEndpointResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

PublishList

POST /v2/configuration/list
Description

Get all published nodes for a server endpoint. The group field that was used in the Connection Model to start publishing must also be specified in this connection model.

Parameters
Type Name Schema
Body body
required		 PublishedItemListRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success PublishedItemListResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

PublishNodes

POST /v2/configuration/nodes
Description

PublishNodes enables a client to add a set of nodes to be published. Further information is provided in the OPC Publisher documentation.

Parameters
Type Name Description Schema
Body body
required		 The request contains the nodes to publish. PublishedNodesEntryModel
Responses
HTTP Code Description Schema
200 Success PublishedNodesResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

UnpublishNodes

POST /v2/configuration/nodes/unpublish
Description

UnpublishNodes method enables a client to remove nodes from a previously configured DataSetWriter. Further information is provided in the OPC Publisher documentation.

Parameters
Type Name Description Schema
Body body
required		 The request payload specifying the nodes to unpublish. PublishedNodesEntryModel
Responses
HTTP Code Description Schema
200 Success PublishedNodesResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

UnpublishAllNodes

POST /v2/configuration/nodes/unpublish/all
Description

Unpublish all specified nodes or all nodes in the publisher configuration. Further information is provided in the OPC Publisher documentation.

Parameters
Type Name Description Schema
Body body
required		 The request contains the parts of the configuration to remove. PublishedNodesEntryModel
Responses
HTTP Code Description Schema
200 Success PublishedNodesResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

PublishStart

POST /v2/configuration/start
Description

Start publishing values from a node on a server. The group field in the Connection Model can be used to specify a writer group identifier that will be used in the configuration entry that is created from it inside the OPC Publisher.

Parameters
Type Name Description Schema
Body body
required		 The server and node to publish. PublishStartRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success PublishStartResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

PublishStop

POST /v2/configuration/stop
Description

Stop publishing values from a node on the specified server. The group field that was used in the Connection Model to start publishing must also be specified in this connection model.

Parameters
Type Name Description Schema
Body body
required		 The node to stop publishing PublishStopRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success PublishStopResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Diagnostics


This section lists the diagnostics APi provided by OPC Publisher providing connection related diagnostics API methods.


The method name for all transports other than HTTP (which uses the shown HTTP methods and resource uris) is the name of the subsection header. To use the version specific method append “_V1” or “_V2” to the method name.

ResetAllClients

GET /v2/reset
Description

Can be used to reset all established connections causing a full reconnect and recreate of all subscriptions.

Responses
HTTP Code Description Schema
200 Success No Content

SetTraceMode

GET /v2/tracemode
Description

Can be used to set trace mode for all established connections. Call within a minute to keep trace mode up or else trace mode will be disabled again after 1 minute. Enabling and resetting tracemode will cause a reconnect of the client.

Responses
HTTP Code Description Schema
200 Success No Content

Discovery


OPC UA and network discovery related API.
The method name for all transports other than HTTP (which uses the shown HTTP methods and resource uris) is the name of the subsection header. To use the version specific method append “_V1” or “_V2” to the method

Discover

POST /v2/discovery
Description

Start network discovery using the provided discovery request configuration. The discovery results are published to the configured default event transport.

Parameters
Type Name Description Schema
Body body
required		 The discovery configuration to use during the discovery run. DiscoveryRequestModel
Responses
HTTP Code Description Schema
200 Success boolean
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Cancel

POST /v2/discovery/cancel
Description

Cancel a discovery run that is ongoing using the discovery request token specified in the discover operation.

Parameters
Type Name Description Schema
Body body
required		 The information needed to cancel the discovery operation. DiscoveryCancelRequestModel
Responses
HTTP Code Description Schema
200 Success boolean
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

FindServer

POST /v2/discovery/findserver
Description

Find servers matching the specified endpoint query spec.

Parameters
Type Name Description Schema
Body body
required		 The endpoint query specifying the matching criteria for the discovered endpoints. ServerEndpointQueryModel
Responses
HTTP Code Description Schema
200 Success ApplicationRegistrationModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Register

POST /v2/discovery/register
Description

Start server registration. The results of the registration are published as events to the default event transport.

Parameters
Type Name Description Schema
Body body
required		 Contains all information to perform the registration request including discovery url to use. ServerRegistrationRequestModel
Responses
HTTP Code Description Schema
200 Success boolean
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

General


This section lists the general APi provided by OPC Publisher providing all connection, endpoint and address space related API methods.


The method name for all transports other than HTTP (which uses the shown HTTP methods and resource uris) is the name of the subsection header. To use the version specific method append “_V1” or “_V2” to the method name.

BrowseStream (only HTTP transport)

POST /v2/browse
Description

Recursively browse a node to discover its references and nodes. The results are returned as a stream of nodes and references. Consult the relevant section of the OPC UA reference specification for more information.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. BrowseStreamRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success BrowseStreamChunkModelIAsyncEnumerable
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

Browse

POST /v2/browse/first
Description

Browse a a node to discover its references. For more information consult the relevant section of the OPC UA reference specification. The operation might return a continuation token. The continuation token can be used in the BrowseNext method call to retrieve the remainder of references or additional continuation tokens.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. BrowseFirstRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success BrowseFirstResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

BrowseNext

POST /v2/browse/next
Description

Browse next

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. BrowseNextRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success BrowseNextResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

BrowsePath

POST /v2/browse/path
Description

Translate a start node and browse path into 0 or more target nodes. Allows programming aginst types in OPC UA. For more information consult the relevant section of the OPC UA reference specification.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. BrowsePathRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success BrowsePathResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

MethodCall

POST /v2/call
Description

Call a method on the OPC UA server endpoint with the specified input arguments and received the result in the form of the method output arguments. See the relevant section of the OPC UA reference specification for more information.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. MethodCallRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success MethodCallResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

MethodMetadata

POST /v2/call/$metadata
Description

Get the metadata for calling the method. This API is obsolete. Use the more powerful GetMetadata method instead.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. MethodMetadataRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success MethodMetadataResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

GetServerCapabilities

POST /v2/capabilities
Description

Get the capabilities of the server. The server capabilities are exposed as a property of the server object and this method provides a convinient way to retrieve them.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. RequestHeaderModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success ServerCapabilitiesModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

GetEndpointCertificate

POST /v2/certificate
Description

Get a server endpoint’s certificate and certificate chain if available.

Parameters
Type Name Description Schema
Body body
required		 The server endpoint to get the certificate for. EndpointModel
Responses
HTTP Code Description Schema
200 Success X509CertificateChainModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryGetServerCapabilities

POST /v2/history/capabilities
Description

Get the historian capabilities exposed as part of the OPC UA server server object.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. RequestHeaderModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryServerCapabilitiesModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryGetConfiguration

POST /v2/history/configuration
Description

Get the historian configuration of a historizing node in the OPC UA server

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. HistoryConfigurationRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryConfigurationResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryRead

POST /v2/historyread/first
Description

Read the history using the respective OPC UA service call. See the relevant section of the OPC UA reference specification for more information. If continuation is returned the remaining results of the operation can be read using the HistoryReadNext method.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. VariantValueHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success VariantValueHistoryReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadNext

POST /v2/historyread/next
Description

Read next history using the respective OPC UA service call. See the relevant section of the OPC UA reference specification for more information.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. HistoryReadNextRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success VariantValueHistoryReadNextResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryUpdate

POST /v2/historyupdate
Description

Update history using the respective OPC UA service call. Consult the relevant section of the OPC UA reference specification for more information.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. VariantValueHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

GetMetadata

POST /v2/metadata
Description

Get the type metadata for a any node. For data type nodes the response contains the data type metadata including fields. For method nodes the output and input arguments metadata is provided. For objects and object types the instance declaration is returned.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. NodeMetadataRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success NodeMetadataResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

CompileQuery

POST /v2/query/compile
Description

Compile a query string into a query spec that can be used when setting up event filters on monitored items that monitor events.

Parameters
Type Name Description Schema
Body body
required		 The compilation request and connection information. QueryCompilationRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success QueryCompilationResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

ValueRead

POST /v2/read
Description

Read the value of a variable node. This uses the service detailed in the relevant section of the OPC UA reference specification.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. ValueReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success ValueReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

NodeRead

POST /v2/read/attributes
Description

Read any writeable attribute of a specified node on the server. See the relevant section of the OPC UA reference specification for more information. The attributes supported by the node are dependend on the node class of the node.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. ReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success ReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

TestConnection

POST /v2/test
Description

Test connection to an opc ua server. The call will not establish any persistent connection but will just allow a client to test that the server is available.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. TestConnectionRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success TestConnectionResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

ValueWrite

POST /v2/write
Description

Write the value of a variable node. This uses the service detailed in the relevant section of the OPC UA reference specification.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. ValueWriteRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success ValueWriteResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

NodeWrite

POST /v2/write/attributes
Description

Write any writeable attribute of a specified node on the server. See the relevant section of the OPC UA reference specification for more information. The attributes supported by the node are dependend on the node class of the node.

Parameters
Type Name Description Schema
Body body
required		 The request payload and connection information identifying the server to connect to perform the operation on. WriteRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success WriteResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

History


This section lists all OPC UA HDA or Historian related API provided by OPC Publisher.


The method name for all transports other than HTTP (which uses the shown HTTP methods and resource uris) is the name of the subsection header. To use the version specific method append “_V1” or “_V2” to the method name.

HistoryDeleteEvents

POST /v2/history/events/delete
Description

Delete event entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The events to delete in the timeseries. DeleteEventsDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryInsertEvents

POST /v2/history/events/insert
Description

Insert event entries into a specified timeseries of the historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The events to insert into the timeseries. UpdateEventsDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryStreamEvents (only HTTP transport)

POST /v2/history/events/read
Description

Read an entire event timeseries from an OPC UA server historian as stream. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The events to read in the timeseries. ReadEventsDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricEventModelIAsyncEnumerable
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadEvents

POST /v2/history/events/read/first
Description

Read an event timeseries inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The events to read in the timeseries. ReadEventsDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricEventModelArrayHistoryReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadEventsNext

POST /v2/history/events/read/next
Description

Continue reading an event timeseries inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The continuation from a previous read request. HistoryReadNextRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricEventModelArrayHistoryReadNextResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReplaceEvents

POST /v2/history/events/replace
Description

Replace events in a timeseries in the historian of the OPC UA server. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The events to replace with in the timeseries. UpdateEventsDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryUpsertEvents

POST /v2/history/events/upsert
Description

Upsert events into a time series of the opc server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The events to upsert into the timeseries. UpdateEventsDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryDeleteValues

POST /v2/history/values/delete
Description

Delete value change entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to delete in the timeseries. DeleteValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryDeleteValuesAtTimes

POST /v2/history/values/delete/attimes
Description

Delete value change entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to delete in the timeseries. DeleteValuesAtTimesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryDeleteModifiedValues

POST /v2/history/values/delete/modified
Description

Delete value change entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to delete in the timeseries. DeleteValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryInsertValues

POST /v2/history/values/insert
Description

Insert value change entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to insert into the timeseries. UpdateValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryStreamValues (only HTTP transport)

POST /v2/history/values/read
Description

Read an entire timeseries from an OPC UA server historian as stream. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelIAsyncEnumerable
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryStreamValuesAtTimes (only HTTP transport)

POST /v2/history/values/read/attimes
Description

Read specific timeseries data from an OPC UA server historian as stream. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadValuesAtTimesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelIAsyncEnumerable
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadValues

POST /v2/history/values/read/first
Description

Read a data change timeseries inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelArrayHistoryReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadValuesAtTimes

POST /v2/history/values/read/first/attimes
Description

Read parts of a timeseries inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadValuesAtTimesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelArrayHistoryReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadModifiedValues

POST /v2/history/values/read/first/modified
Description

Read modified changes in a timeseries inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadModifiedValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelArrayHistoryReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadProcessedValues

POST /v2/history/values/read/first/processed
Description

Read processed timeseries data inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadProcessedValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelArrayHistoryReadResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryStreamModifiedValues (only HTTP transport)

POST /v2/history/values/read/modified
Description

Read an entire modified series from an OPC UA server historian as stream. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadModifiedValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelIAsyncEnumerable
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReadValuesNext

POST /v2/history/values/read/next
Description

Continue reading a timeseries inside the OPC UA server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The continuation token from a previous read operation. HistoryReadNextRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelArrayHistoryReadNextResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryStreamProcessedValues (only HTTP transport)

POST /v2/history/values/read/processed
Description

Read processed timeseries data from an OPC UA server historian as stream. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to read in the timeseries. ReadProcessedValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoricValueModelIAsyncEnumerable
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryReplaceValues

POST /v2/history/values/replace
Description

Replace value change entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to replace with in the timeseries. UpdateValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack

HistoryUpsertValues

POST /v2/history/values/upsert
Description

Upsert value change entries in a timeseries of the server historian. See the relevant section of the OPC UA reference specification and respective service documentation for more information.

Parameters
Type Name Description Schema
Body body
required		 The values to upsert into the timeseries. UpdateValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 Success HistoryUpdateResponseModel
Consumes
  • application/json
  • text/json
  • application/*+json
  • application/x-msgpack
Produces
  • text/plain
  • application/json
  • text/json
  • application/x-msgpack