Skip to content

Latest commit

 

History

History
3884 lines (2351 loc) · 118 KB

api.md

File metadata and controls

3884 lines (2351 loc) · 118 KB
Raw

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 The operation was successful. No Content
400 The passed in information is invalid ProblemDetails
500 An internal error ocurred. ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • 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 The operation was successful. No Content
400 The passed in information is invalid ProblemDetails
500 An internal error ocurred. ProblemDetails
Produces
  • application/json
  • application/x-msgpack

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 The operation was successful. No Content
400 The passed in information is invalid ProblemDetails
500 An internal error ocurred. ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • 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 string
Responses
HTTP Code Description Schema
200 The operation was successful. No Content
400 The passed in information such store name is invalid ProblemDetails
404 Nothing could be found. ProblemDetails
500 An internal error ocurred. ProblemDetails
Produces
  • application/json
  • application/x-msgpack

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 string
Responses
HTTP Code Description Schema
200 The operation was successful. < X509CertificateModel > array
400 The passed in information such as store name is invalid ProblemDetails
404 Nothing could be found. ProblemDetails
500 An internal error ocurred. ProblemDetails
Produces
  • application/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 string
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 The operation was successful. No Content
400 The passed in information such as store name is invalid ProblemDetails
500 An internal error ocurred. ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • 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 string
Path thumbprint
required		 The thumbprint of the certificate to delete. string
Responses
HTTP Code Description Schema
200 The operation was successful. No Content
400 The passed in information such store name is invalid ProblemDetails
404 Nothing could be found. ProblemDetails
500 An internal error ocurred. ProblemDetails
Produces
  • application/json
  • application/x-msgpack

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 string
Responses
HTTP Code Description Schema
200 The operation was successful. < string (byte) > array
400 The passed in information such as store name is invalid ProblemDetails
404 Nothing could be found. ProblemDetails
500 An internal error ocurred. ProblemDetails
Produces
  • application/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 string
Responses
HTTP Code Description Schema
200 The operation was successful. No Content
400 The passed in information such store name is invalid ProblemDetails
404 Nothing could be found. ProblemDetails
500 An internal error ocurred. ProblemDetails
Produces
  • application/json
  • application/x-msgpack

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 string
Body body
required		 The pfx encoded certificate. string (byte)
Responses
HTTP Code Description Schema
200 The operation was successful. No Content
400 The passed in information is invalid ProblemDetails
500 An internal error ocurred. ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • 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 The data was retrieved. GetConfiguredEndpointsResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Produces
  • application/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 The operation was successful. No Content
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • 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 The operation was successful. PublishedNodesResponseModel
404 The endpoint was not found to add to ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 OPC Publisher.

Parameters
Type Name Description Schema
Body body
required		 The nodes to publish or unpublish. PublishBulkRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful. PublishBulkResponseModel
404 The item could not be unpublished ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful. < PublishDiagnosticInfoModel > array
405 Call not supported or functionality disabled. ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Produces
  • application/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 The information was returned. GetConfiguredNodesOnEndpointResponseModel
400 The passed in information is invalid ProblemDetails
404 The entry was not found. ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The items were found and returned. PublishedItemListResponseModel
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful. PublishedNodesResponseModel
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful. PublishedNodesResponseModel
404 The nodes could not be unpublished ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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
optional		 The request contains the parts of the configuration to remove. PublishedNodesEntryModel
Responses
HTTP Code Description Schema
200 The operation was successful. PublishedNodesResponseModel
404 The nodes could not be unpublished ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 OPC Publisher.

Parameters
Type Name Description Schema
Body body
required		 The server and node to publish. PublishStartRequestModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful. PublishStartResponseModel
400 The passed in information is invalid ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful. PublishStopResponseModel
404 The item could not be unpublished ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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.

GetActiveConnections

GET /v2/connections
Description

Get all active connections the publisher is currently managing.

Responses
HTTP Code Description Schema
200 The operation was successful. < ConnectionModel > array
500 An unexpected error occurred ProblemDetails
Produces
  • application/json
  • application/x-msgpack

GetChannelDiagnostics

GET /v2/diagnostics/channels
Description

Get channel diagnostic information for all connections.

Responses
HTTP Code Description Schema
200 The operation was successful. < ChannelDiagnosticModel > array
500 An unexpected error occurred ProblemDetails
Produces
  • application/json
  • application/x-msgpack

WatchChannelDiagnostics

GET /v2/diagnostics/channels/watch
Description

Get channel diagnostic information for all connections. The first set of diagnostics are the diagnostics active for all connections, continue reading to get updates.

Responses
HTTP Code Description Schema
200 The operation was successful. ChannelDiagnosticModelIAsyncEnumerable
500 An unexpected error occurred ProblemDetails
Produces
  • application/json
  • application/x-msgpack

GetConnectionDiagnostics

GET /v2/diagnostics/connections
Description

Get diagnostics for all active clients including server and client session diagnostics.

Responses
HTTP Code Description Schema
200 The operation was successful. ConnectionDiagnosticsModelIAsyncEnumerable
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Produces
  • application/json
  • application/x-msgpack

ResetAllConnections

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 The operation was successful. No Content
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Produces
  • application/json
  • application/x-msgpack

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 The operation was successful or the response payload contains relevant error information. boolean
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. boolean
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. ApplicationRegistrationModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. boolean
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

FileSystem

This section lists the file transfer API provided by OPC Publisher providing access to file transfer services to move files in and out of a server using the File transfer specification.

        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.

CreateDirectory

POST /v2/filesystem/create/directory/{name}
Description

Create a new directory in an existing file system or directory on the server.

Parameters
Type Name Description Schema
Path name
required		 The name of the directory to create as child under the parent directory provided string
Body body
required		 The file system or directory object to create the directory in and the connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileSystemObjectModelServiceResponse
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

CreateFile

POST /v2/filesystem/create/file/{name}
Description

Create a new file in a directory or file system on the server

Parameters
Type Name Description Schema
Path name
required		 The name of the file to create as child under the directory or filesystem provided string
Body body
required		 The file system or directory object to create the file in and the connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileSystemObjectModelServiceResponse
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

DeleteFileSystemObject

POST /v2/filesystem/delete
Description

Delete a file or directory in an existing file system on the server.

Parameters
Type Name Description Schema
Body body
required		 The file or directory object to delete and the connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. ServiceResultModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

DeleteFileOrDirectory

POST /v2/filesystem/delete/{fileOrDirectoryNodeId}
Description

Delete a file or directory in the specified directory or file system.

Parameters
Type Name Description Schema
Path fileOrDirectoryNodeId
required		 The node id of the file or directory to delete string
Body body
required		 The filesystem or directory object in which to delete the specified file or directory and the connection to use for the operation. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. ServiceResultModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

Download

GET /v2/filesystem/download
Description

Download a file from the server

Parameters
Type Name Description Schema
Header x-ms-connection
required		 The connection information identifying the server to connect to perform the operation on. This is passed as json serialized via the header "x-ms-connection" string
Header x-ms-target
required		 The file object to upload. This is passed as json serialized via the header "x-ms-target" string
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. No Content
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Produces
  • application/json
  • application/x-msgpack

GetFileInfo

POST /v2/filesystem/info/file
Description

Gets the file information for a file on the server.

Parameters
Type Name Description Schema
Body body
required		 The file object and connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileInfoModelServiceResponse
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetFileSystems

POST /v2/filesystem/list
Description

Gets all file systems of the server.

Parameters
Type Name Description Schema
Body body
required		 The connection information identifying the server to connect to perform the operation on. ConnectionModel
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileSystemObjectModelServiceResponseIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetDirectories

POST /v2/filesystem/list/directories
Description

Gets all directories in a directory or file system

Parameters
Type Name Description Schema
Body body
required		 The directory or filesystem object and connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileSystemObjectModelIEnumerableServiceResponse
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetFiles

POST /v2/filesystem/list/files
Description

Get files in a directory or file system on a server.

Parameters
Type Name Description Schema
Body body
required		 The directory or filesystem object and connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileSystemObjectModelIEnumerableServiceResponse
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetParent

POST /v2/filesystem/parent
Description

Gets the parent directory or filesystem of a file or directory.

Parameters
Type Name Description Schema
Body body
required		 The file or directory object and connection information identifying the server to connect to perform the operation on. FileSystemObjectModelRequestEnvelope
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. FileSystemObjectModelServiceResponse
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

Upload

POST /v2/filesystem/upload
Description

Upload a file to the server.

Parameters
Type Name Description Schema
Header x-ms-connection
required		 The connection information identifying the server to connect to perform the operation on. This is passed as json serialized via the header "x-ms-connection" string
Header x-ms-options
required		 The file write options to use passed as header "x-ms-mode" string
Header x-ms-target
required		 The file object to upload. This is passed as json serialized via the header "x-ms-target" string
Responses
HTTP Code Description Schema
200 The operation was successful or the response payload contains relevant error information. No Content
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. BrowseStreamChunkModelIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. BrowseFirstResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. BrowseNextResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. BrowsePathResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. MethodCallResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. MethodMetadataResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. ServerCapabilitiesModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. X509CertificateChainModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryServerCapabilitiesModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryConfigurationResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. VariantValueHistoryReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. VariantValueHistoryReadNextResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. NodeMetadataResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. QueryCompilationResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. ValueReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. ReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. TestConnectionResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. ValueWriteResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. WriteResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricEventModelIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricEventModelArrayHistoryReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricEventModelArrayHistoryReadNextResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelArrayHistoryReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelArrayHistoryReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelArrayHistoryReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelArrayHistoryReadResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelArrayHistoryReadNextResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoricValueModelIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/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 The operation was successful or the response payload contains relevant error information. HistoryUpdateResponseModel
400 The passed in information is invalid ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

Writer

This section contains the API to configure data set writers and writer groups inside OPC Publisher. It supersedes the configuration API. Applications should use one or the other, but not both at the same time.

        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.

ExpandAndCreateOrUpdateDataSetWriterEntries

POST /v2/writer
Description

Create a series of published nodes entries using the provided entry as template. The entry is expanded using expansion configuration provided. Expanded entries are returned one by one with error information if any. The configuration is also saved in the local configuration store. The server must be online and accessible for the expansion to work.

Parameters
Type Name Description Schema
Body body
required		 The entry to create for the writer and node expansion configuration to use PublishedNodeExpansionModelPublishedNodesEntryRequestModel
Responses
HTTP Code Description Schema
200 The item was created PublishedNodesEntryModelServiceResponseIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to update. ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

CreateOrUpdateDataSetWriterEntry

PUT /v2/writer
Description

Create a published nodes entry for a specific writer group and dataset writer. The entry must specify a unique writer group and dataset writer id. A null value is treated as empty string. If the entry is found it is replaced, if it is not found, it is created. If more than one entry is found with the same writer group and writer id an error is returned. The writer entry provided must include at least one node which will be the initial set. All nodes must specify a unique dataSetFieldId. A null value is treated as empty string. Publishing intervals at node level are also not supported and generate an error. Publishing intervals must be configured at the data set writer level.

Parameters
Type Name Description Schema
Body body
required		 The entry to create for the writer PublishedNodesEntryModel
Responses
HTTP Code Description Schema
200 The item was created No Content
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to update. ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

CreateOrUpdateAsset

POST /v2/writer/assets/create
Description

Creates an asset from the entry in the request and the configuration provided in the Web of Things Asset configuration file. The entry must contain a data set name which will be used as the asset name. The writer can stay empty. It will be set to the asset id on successful return. The server must support the WoT profile per . The asset will be created and the configuration updated to reference it. A wait time can be provided as optional query parameter to wait until the server has settled after uploading the configuration.

Parameters
Type Name Description Schema
Body body
required		 The contains the entry and WoT file to configure the server to expose the asset. ByteArrayPublishedNodeCreateAssetRequestModel
Responses
HTTP Code Description Schema
200 The asset was created PublishedNodesEntryModelServiceResponse
400 The passed in information is invalid ProblemDetails
403 Forbidden ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

DeleteAsset

POST /v2/writer/assets/delete
Description

Delete the asset referenced by the entry in the request. The entry must contain the asset id to delete. The asset id is the data set writer id. The entry must also contain the writer group id or deletion of the asset in the configuration will fail before the asset is deleted. The server must support WoT connectivity profile per . First the entry in the configuration will be deleted and then the asset on the server. If deletion of the asset in the configuration fails it will not be deleted in the server. An optional request option force can be used to force the deletion of the asset in the server regardless of the failure to delete the entry in the configuration.

Parameters
Type Name Description Schema
Body body
required		 Request that contains the entry of the asset that should be deleted. PublishedNodeDeleteAssetRequestModel
Responses
HTTP Code Description Schema
200 The asset was deleted successfully ServiceResultModel
400 The passed in information is invalid ProblemDetails
403 Forbidden ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetAllAssets

POST /v2/writer/assets/list
Description

Get a list of entries representing the assets in the server. This will not touch the configuration, it will obtain the list from the server. If the server does not support the result will be empty.

Parameters
Type Name Description Schema
Body body
required		 The entry to use to list the assets with the optional header information used when invoking services on the server. RequestHeaderModelPublishedNodesEntryRequestModel
Responses
HTTP Code Description Schema
200 Successfully completed the listing PublishedNodesEntryModelServiceResponseIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
403 Forbidden ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

ExpandWriter

POST /v2/writer/expand
Description

Expands the provided nodes in the entry to a series of published node entries. The provided entry is used template. The entry is expanded using expansion configuration provided. Expanded entries are returned one by one with error information if any. The configuration is not updated but the resulting entries can be modified and later saved in the configuration using the configuration API. The server must be online and accessible for the expansion to work.

Parameters
Type Name Description Schema
Body body
required		 The entry to expand and the node expansion configuration to use. If no configuration is provided a default configuration is used which and no error entries are returned. PublishedNodeExpansionModelPublishedNodesEntryRequestModel
Responses
HTTP Code Description Schema
200 The item was created PublishedNodesEntryModelServiceResponseIAsyncEnumerable
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to update. ProblemDetails
408 The operation timed out. ProblemDetails
500 An unexpected error occurred ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetDataSetWriterEntry

GET /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}
Description

Get the published nodes entry for a specific writer group and dataset writer. Dedicated errors are returned if no, or no unique entry could be found. The entry does not contain the nodes. Nodes can be retrieved using the GetNodes API.

Parameters
Type Name Description Schema
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Responses
HTTP Code Description Schema
200 The item was found PublishedNodesEntryModel
400 The passed in information is invalid ProblemDetails
403 There is no unique item present. ProblemDetails
404 The item was not found ProblemDetails
Produces
  • application/json
  • application/x-msgpack

AddOrUpdateNode

PUT /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}
Description

Add a node to a dedicated data set writer in a writer group. A node must have a unique DataSetFieldId. If the field already exists, the node is updated. If a node does not have a dataset field id an error is returned. Publishing intervals at node level are also not supported and generate an error. Publishing intervals must be configured at the data set writer level.

Parameters
Type Name Description Schema
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Query insertAfterFieldId
optional		 Field after which to insert the nodes. If not specified, nodes are added at the end of the entry string
Body body
required		 Node to add or update OpcNodeModel
Responses
HTTP Code Description Schema
200 The item was added No Content
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to update. ProblemDetails
404 An entry was not found to add the node to ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

RemoveDataSetWriterEntry

DELETE /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}
Description

Remove the published nodes entry for a specific data set writer in a writer group. Dedicated errors are returned if no, or no unique entry could be found.

Parameters
Type Name Description Schema Default
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Query force
optional		 Force delete all writers even if more than one were found. Does not error when none were found. boolean "false"
Responses
HTTP Code Description Schema
200 The entry was removed No Content
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to remove. ProblemDetails
404 The entry to remove was not found ProblemDetails
Produces
  • application/json
  • application/x-msgpack

AddOrUpdateNodes

POST /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}/add
Description

Add Nodes to a dedicated data set writer in a writer group. Each node must have a unique DataSetFieldId. If the field already exists, the node is updated. If a node does not have a dataset field id an error is returned. Publishing intervals at node level are also not supported and generate an error. Publishing intervals must be configured at the data set writer level.

Parameters
Type Name Description Schema
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Query insertAfterFieldId
optional		 Field after which to insert the nodes. If not specified, nodes are added at the end of the entry string
Body body
required		 Nodes to add or update < OpcNodeModel > array
Responses
HTTP Code Description Schema
200 The items were added No Content
400 The passed in information is invalid ProblemDetails
403 A unique entry could not be found to add to. ProblemDetails
404 The entry was not found ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetNodes

GET /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}/nodes
Description

Get Nodes from a data set writer in a writer group. The nodes can optionally be offset from a previous last node identified by the dataSetFieldId and pageanated by the pageSize. If the dataSetFieldId is not found, an empty list is returned. If the dataSetFieldId is not specified, the first page is returned.

Parameters
Type Name Description Schema
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Query lastDataSetFieldId
optional		 the field id after which to start the page. If not specified, nodes from the beginning are returned. string
Query pageSize
optional		 Number of nodes to return integer (int32)
Responses
HTTP Code Description Schema
200 The items were found < OpcNodeModel > array
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to get nodes from. ProblemDetails
404 The entry was not found ProblemDetails
Produces
  • application/json
  • application/x-msgpack

RemoveNodes

POST /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}/remove
Description

Remove Nodes that match the provided data set field ids from a data set writer in a writer group. If one of the fields is not found, no error is returned, however, if all fields are not found an error is returned.

Parameters
Type Name Description Schema
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Body body
required		 The identifiers of the fields to remove < string > array
Responses
HTTP Code Description Schema
200 Some or all items were removed No Content
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to remove from. ProblemDetails
404 The entry or all items to remove were not found ProblemDetails
Consumes
  • application/json
  • application/x-msgpack
Produces
  • application/json
  • application/x-msgpack

GetNode

GET /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}/{dataSetFieldId}
Description

Get a node from a dataset in a writer group. Dedicated errors are returned if no, or no unique entry could be found, or the node does not exist.

Parameters
Type Name Description Schema
Path dataSetFieldId
required		 The data set field id of the node to return string
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Responses
HTTP Code Description Schema
200 The item was retrieved OpcNodeModel
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to get a node from. ProblemDetails
404 The entry or item was not found ProblemDetails
Produces
  • application/json
  • application/x-msgpack

RemoveNode

DELETE /v2/writer/{dataSetWriterGroup}/{dataSetWriterId}/{dataSetFieldId}
Description

Remove a node with the specified data set field id from a data set writer in a writer group. If the field is not found, an error is returned.

Parameters
Type Name Description Schema
Path dataSetFieldId
required		 Identifier of the field to remove string
Path dataSetWriterGroup
required		 The writer group name of the entry string
Path dataSetWriterId
required		 The data set writer identifer of the entry string
Responses
HTTP Code Description Schema
200 The item was removed No Content
400 The passed in information is invalid ProblemDetails
403 A unique item could not be found to remove from. ProblemDetails
404 The entry or item to remove was not found ProblemDetails
Produces
  • application/json
  • application/x-msgpack