Definitions
AdditionalData
Flags that are set by the historian when returning archived values.
Type : enum (None, Partial, ExtraData, MultipleValues)
AggregateConfigurationModel
Aggregate configuration
| Name | Description | Schema |
|---|---|---|
| percentDataBad optional |
Percent of data that is bad | integer (int32) |
| percentDataGood optional |
Percent of data that is good | integer (int32) |
| treatUncertainAsBad optional |
Whether to treat uncertain as bad | boolean |
| useSlopedExtrapolation optional |
Whether to use sloped extrapolation. | boolean |
ApplicationInfoModel
Application info model
| Name | Description | Schema |
|---|---|---|
| applicationId required |
Unique application id | string |
| applicationName optional |
Default name of application | string |
| applicationType optional |
ApplicationType | |
| applicationUri required |
Unique application uri | string |
| capabilities optional |
The capabilities advertised by the server. | < string > array |
| created optional |
OperationContextModel | |
| discovererId optional |
Discoverer that registered the application | string |
| discoveryProfileUri optional |
Discovery profile uri | string |
| discoveryUrls optional |
Discovery urls of the server | < string > array |
| gatewayServerUri optional |
Gateway server uri | string |
| hostAddresses optional |
Host addresses of server application or null | < string > array |
| locale optional |
Locale of default name - defaults to “en” | string |
| localizedNames optional |
Localized Names of application keyed on locale | < string, string > map |
| notSeenSince optional |
Last time application was seen if not visible | string (date-time) |
| productUri optional |
Product uri | string |
| siteId optional |
Site of the application Example : "productionlineA" |
string |
| updated optional |
OperationContextModel |
ApplicationRegistrationModel
Application with optional list of endpoints
| Name | Description | Schema |
|---|---|---|
| application required |
ApplicationInfoModel | |
| endpoints optional |
List of endpoints for it | < EndpointRegistrationModel > array |
ApplicationType
Application type
Type : enum (Server, Client, ClientAndServer, DiscoveryServer)
AttributeReadRequestModel
Attribute to read
| Name | Description | Schema |
|---|---|---|
| attribute required |
NodeAttribute | |
| nodeId required |
Node to read from or write to (mandatory) Minimum length : 1 |
string |
AttributeReadResponseModel
Attribute value read
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| value required |
Attribute value | object |
AttributeWriteRequestModel
Attribute and value to write to it
| Name | Description | Schema |
|---|---|---|
| attribute required |
NodeAttribute | |
| nodeId required |
Node to write to (mandatory) Minimum length : 1 |
string |
| value required |
Value to write (mandatory) | object |
AttributeWriteResponseModel
Attribute write result
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
AuthenticationMethodModel
Authentication Method model
| Name | Description | Schema |
|---|---|---|
| configuration optional |
Method specific configuration | object |
| credentialType optional |
CredentialType | |
| id required |
Method id Minimum length : 1 |
string |
| securityPolicy optional |
Security policy to use when passing credential. | string |
BrowseDirection
Direction to browse
Type : enum (Forward, Backward, Both)
BrowseFirstRequestModel
Browse request model
| Name | Description | Schema |
|---|---|---|
| direction optional |
BrowseDirection | |
| header optional |
RequestHeaderModel | |
| maxReferencesToReturn optional |
Max number of references to return. There might be less returned as this is up to the client restrictions. Set to 0 to return no references or target nodes. (default is decided by client e.g. 60) |
integer (int64) |
| noSubtypes optional |
Whether to include subtypes of the reference type. (default is false) |
boolean |
| nodeClassFilter optional |
Filter returned target nodes by only returning nodes that have classes defined in this array. (default: null - all targets are returned) |
enum (Object, Variable, Method, ObjectType, VariableType, ReferenceType, DataType, View) |
| nodeId optional |
Node to browse. (defaults to root folder). |
string |
| nodeIdsOnly optional |
Whether to only return the raw node id information and not read the target node. (default is false) |
boolean |
| readVariableValues optional |
Whether to read variable values on target nodes. (default is false) |
boolean |
| referenceTypeId optional |
Reference types to browse. (default: hierarchical). |
string |
| targetNodesOnly optional |
Whether to collapse all references into a set of unique target nodes and not show reference information. (default is false) |
boolean |
| view optional |
BrowseViewModel |
BrowseFirstRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
BrowseFirstRequestModel |
BrowseFirstResponseModel
Browse response model
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| node required |
NodeModel | |
| references required |
References returned | < NodeReferenceModel > array |
BrowseNextRequestModel
Request node browsing continuation
| Name | Description | Schema |
|---|---|---|
| abort optional |
Whether to abort browse and release. (default: false) |
boolean |
| continuationToken required |
Continuation token from previews browse request. (mandatory) Minimum length : 1 |
string |
| header optional |
RequestHeaderModel | |
| nodeIdsOnly optional |
Whether to only return the raw node id information and not read the target node. (default is false) |
boolean |
| readVariableValues optional |
Whether to read variable values on target nodes. (default is false) |
boolean |
| targetNodesOnly optional |
Whether to collapse all references into a set of unique target nodes and not show reference information. (default is false) |
boolean |
BrowseNextRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
BrowseNextRequestModel |
BrowseNextResponseModel
Result of node browse continuation
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| references required |
References returned | < NodeReferenceModel > array |
BrowsePathRequestModel
Browse nodes by path
| Name | Description | Schema |
|---|---|---|
| browsePaths required |
The paths to browse from node. (mandatory) |
< < string > array > array |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to browse from (defaults to root folder). | string |
| nodeIdsOnly optional |
Whether to only return the raw node id information and not read the target node. (default is false) |
boolean |
| readVariableValues optional |
Whether to read variable values on target nodes. (default is false) |
boolean |
BrowsePathRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
BrowsePathRequestModel |
BrowsePathResponseModel
Result of node browse continuation
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| targets optional |
Targets | < NodePathTargetModel > array |
BrowseStreamChunkModelIAsyncEnumerable
Type : object
BrowseStreamRequestModel
Browse stream request model
| Name | Description | Schema |
|---|---|---|
| direction optional |
BrowseDirection | |
| header optional |
RequestHeaderModel | |
| noRecurse optional |
Whether to not browse recursively (default is false) |
boolean |
| noSubtypes optional |
Whether to include subtypes of the reference type. (default is false) |
boolean |
| nodeClassFilter optional |
Filter returned target nodes by only returning nodes that have classes defined in this array. (default: null - all targets are returned) |
enum (Object, Variable, Method, ObjectType, VariableType, ReferenceType, DataType, View) |
| nodeId optional |
Start nodes to browse. (defaults to root folder). |
< string > array |
| readVariableValues optional |
Whether to read variable values on source nodes. (default is false) |
boolean |
| referenceTypeId optional |
Reference types to browse. (default: hierarchical). |
string |
| view optional |
BrowseViewModel |
BrowseStreamRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
BrowseStreamRequestModel |
BrowseViewModel
View to browse
| Name | Description | Schema |
|---|---|---|
| timestamp optional |
Browses at or before this timestamp. | string (date-time) |
| version optional |
Browses specific version of the view. | integer (int64) |
| viewId required |
Node of the view to browse Minimum length : 1 |
string |
ByteArrayPublishedNodeCreateAssetRequestModel
Request to create an asset in the configuration api
| Name | Description | Schema |
|---|---|---|
| configuration required |
The asset configuration to use when creating the asset. | string (byte) |
| entry required |
PublishedNodesEntryModel | |
| header optional |
RequestHeaderModel | |
| waitTime optional |
Time to wait after the configuration is applied to perform the configuration of the asset in the configuration api. This is to let the server settle. |
string (date-span) |
ChannelDiagnosticModel
Channel diagnostics model
| Name | Description | Schema |
|---|---|---|
| channelId optional |
The id assigned to the channel that the token belongs to. |
integer (int64) |
| client optional |
ChannelKeyModel | |
| connection required |
ConnectionModel | |
| createdAt optional |
When the token was created by the server (refers to the server’s clock). |
string (date-time) |
| lifetime optional |
The lifetime of the token | string (date-span) |
| localIpAddress optional |
Effective local ip address used for the connection if connected. Empty if disconnected. |
string |
| localPort optional |
The effective local port used when connected, null if disconnected. |
integer (int32) |
| remoteIpAddress optional |
Effective remote ip address used for the connection if connected. Empty if disconnected. |
string |
| remotePort optional |
The effective remote port used when connected, null if disconnected. |
integer (int32) |
| server optional |
ChannelKeyModel | |
| sessionCreated optional |
When the session was created. | string (date-time) |
| sessionId optional |
The session id if connected. Empty if disconnected. | string |
| timeStamp required |
Timestamp of the diagnostic information | string (date-time) |
| tokenId optional |
The id assigned to the token. | integer (int64) |
ChannelDiagnosticModelIAsyncEnumerable
Type : object
ChannelKeyModel
Channel token key model.
| Name | Description | Schema |
|---|---|---|
| iv required |
Iv | < integer (int32) > array |
| key required |
Key | < integer (int32) > array |
| sigLen required |
Signature length | integer (int32) |
ConditionHandlingOptionsModel
Condition handling options model
| Name | Description | Schema |
|---|---|---|
| snapshotInterval optional |
Time interval for sending pending interval snapshot in seconds. | integer (int32) |
| updateInterval optional |
Time interval for sending pending interval updates in seconds. | integer (int32) |
ConnectionDiagnosticsModelIAsyncEnumerable
Type : object
ConnectionModel
Connection model
| Name | Description | Schema |
|---|---|---|
| diagnostics optional |
DiagnosticsModel | |
| endpoint required |
EndpointModel | |
| group optional |
Connection group allows splitting connections per purpose. |
string |
| locales optional |
Optional list of preferred locales in preference order. | < string > array |
| options optional |
ConnectionOptions | |
| user optional |
CredentialModel |
ConnectionOptions
Options that can be applied to a connection
Type : enum (None, UseReverseConnect, NoComplexTypeSystem, NoSubscriptionTransfer, DumpDiagnostics)
ContentFilterElementModel
An expression element in the filter ast
| Name | Description | Schema |
|---|---|---|
| filterOperands optional |
The operands in the element for the operator | < FilterOperandModel > array |
| filterOperator optional |
FilterOperatorType |
ContentFilterModel
Content filter
| Name | Description | Schema |
|---|---|---|
| elements optional |
The flat list of elements in the filter AST | < ContentFilterElementModel > array |
CredentialModel
Credential model. For backwards compatibility the actual credentials to pass to the server is set through the value property.
| Name | Schema |
|---|---|
| type optional |
CredentialType |
| value optional |
UserIdentityModel |
CredentialType
Type of credentials to use for authentication
Type : enum (None, UserName, X509Certificate, JwtToken)
DataChangeTriggerType
Data change trigger
Type : enum (Status, StatusValue, StatusValueTimestamp)
DataLocation
Indicate the data location
Type : enum (Raw, Calculated, Interpolated)
DataSetRoutingMode
Specifies how OPC UA node paths are mapped to message routing paths/topics. Controls automatic topic structure generation from OPC UA address space. Used to create a unified namespace when publishing to message brokers that support hierarchical routing like MQTT.
Type : enum (None, UseBrowseNames, UseBrowseNamesWithNamespaceIndex)
DataTypeMetadataModel
Data type metadata model
| Name | Description | Schema |
|---|---|---|
| dataType optional |
The data type for the instance declaration. | string |
DeadbandType
Deadband type
Type : enum (Absolute, Percent)
DeleteEventsDetailsModel
The events to delete
| Name | Description | Schema |
|---|---|---|
| eventIds required |
Events to delete | < string (byte) > array |
DeleteEventsDetailsModelHistoryUpdateRequestModel
Request node history update
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
DeleteEventsDetailsModel | |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to update (mandatory without browse path) | string |
DeleteEventsDetailsModelHistoryUpdateRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
DeleteEventsDetailsModelHistoryUpdateRequestModel |
DeleteValuesAtTimesDetailsModel
Deletes data at times
| Name | Description | Schema |
|---|---|---|
| reqTimes required |
The timestamps to delete | < string (date-time) > array |
DeleteValuesAtTimesDetailsModelHistoryUpdateRequestModel
Request node history update
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
DeleteValuesAtTimesDetailsModel | |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to update (mandatory without browse path) | string |
DeleteValuesAtTimesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
DeleteValuesAtTimesDetailsModelHistoryUpdateRequestModel |
DeleteValuesDetailsModel
Delete values
| Name | Description | Schema |
|---|---|---|
| endTime optional |
End time to delete until | string (date-time) |
| startTime optional |
Start time | string (date-time) |
DeleteValuesDetailsModelHistoryUpdateRequestModel
Request node history update
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
DeleteValuesDetailsModel | |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to update (mandatory without browse path) | string |
DeleteValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
DeleteValuesDetailsModelHistoryUpdateRequestModel |
DiagnosticsLevel
Level of diagnostics requested in responses
Type : enum (None, Status, Information, Debug, Verbose)
DiagnosticsModel
Diagnostics configuration
| Name | Description | Schema |
|---|---|---|
| auditId optional |
Client audit log entry. (default: client generated) |
string |
| level optional |
DiagnosticsLevel | |
| timeStamp optional |
Timestamp of request. (default: client generated) |
string (date-time) |
DiscoveryCancelRequestModel
Discovery cancel request
| Name | Description | Schema |
|---|---|---|
| context optional |
OperationContextModel | |
| id optional |
Id of discovery request | string |
DiscoveryConfigModel
Discovery configuration api model
| Name | Description | Schema |
|---|---|---|
| addressRangesToScan optional |
Address ranges to scan (null == all wired nics) | string |
| discoveryUrls optional |
List of preset discovery urls to use | < string > array |
| idleTimeBetweenScans optional |
Delay time between discovery sweeps | string (date-span) |
| locales optional |
List of locales to filter with during discovery | < string > array |
| maxNetworkProbes optional |
Max network probes that should ever run. | integer (int32) |
| maxPortProbes optional |
Max port probes that should ever run. | integer (int32) |
| minPortProbesPercent optional |
Probes that must always be there as percent of max. | integer (int32) |
| networkProbeTimeout optional |
Network probe timeout | string (date-span) |
| portProbeTimeout optional |
Port probe timeout | string (date-span) |
| portRangesToScan optional |
Port ranges to scan (null == all unassigned) | string |
DiscoveryMode
Discovery mode to use
Type : enum (Off, Local, Network, Fast, Scan)
DiscoveryRequestModel
Discovery request
| Name | Description | Schema |
|---|---|---|
| configuration optional |
DiscoveryConfigModel | |
| context optional |
OperationContextModel | |
| discovery optional |
DiscoveryMode | |
| id optional |
Id of discovery request | string |
EndpointModel
Endpoint model
| Name | Description | Schema |
|---|---|---|
| alternativeUrls optional |
Alternative endpoint urls that can be used for accessing and validating the server |
< string > array |
| certificate optional |
Endpoint certificate thumbprint | string |
| securityMode optional |
SecurityMode | |
| securityPolicy optional |
Security policy uri to use for communication. default to best. |
string |
| url required |
Endpoint url to use to connect with Minimum length : 1 |
string |
EndpointRegistrationModel
Endpoint registration
| Name | Description | Schema |
|---|---|---|
| authenticationMethods optional |
Supported authentication methods that can be selected to obtain a credential and used to interact with the endpoint. |
< AuthenticationMethodModel > array |
| discovererId optional |
Entity that registered and can access the endpoint | string |
| endpoint optional |
EndpointModel | |
| endpointUrl optional |
Original endpoint url of the endpoint | string |
| id required |
Endpoint identifier which is hashed from the supervisor, site and url. Minimum length : 1 |
string |
| securityLevel optional |
Security level of the endpoint | integer (int32) |
| siteId optional |
Registered site of the endpoint | string |
EventFilterModel
Event filter
| Name | Description | Schema |
|---|---|---|
| selectClauses optional |
Select clauses | < SimpleAttributeOperandModel > array |
| typeDefinitionId optional |
Simple event Type definition node id | string |
| whereClause optional |
ContentFilterModel |
ExceptionDeviationType
Exception deviation type
Type : enum (AbsoluteValue, PercentOfValue, PercentOfRange, PercentOfEURange)
FileInfoModel
File info
| Name | Description | Schema |
|---|---|---|
| lastModified optional |
The time the file was last modified. | string (date-time) |
| maxBufferSize optional |
The maximum number of bytes of the read and write buffers. |
integer (int64) |
| mimeType optional |
The media type of the file based on RFC 2046. | string |
| openCount optional |
The number of currently valid file handles on the file. |
integer (int32) |
| size optional |
The size of the file in Bytes. When a file is currently opened for write, the size might not be accurate or available. |
integer (int64) |
| writable optional |
Whether the file is writable. | boolean |
FileInfoModelServiceResponse
Response envelope
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
| result optional |
FileInfoModel |
FileSystemObjectModel
File system object model
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
The browse path to the filesystem object | < string > array |
| name optional |
The name of the filesystem object | string |
| nodeId optional |
The node id of the filesystem object | string |
FileSystemObjectModelIEnumerableServiceResponse
Response envelope
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| result optional |
Result | < FileSystemObjectModel > array |
FileSystemObjectModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
FileSystemObjectModel |
FileSystemObjectModelServiceResponse
Response envelope
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
| result optional |
FileSystemObjectModel |
FileSystemObjectModelServiceResponseIAsyncEnumerable
Type : object
FilterOperandModel
Filter operand
| Name | Description | Schema |
|---|---|---|
| alias optional |
Optional alias to refer to it makeing it a full blown attribute operand |
string |
| attributeId optional |
NodeAttribute | |
| browsePath optional |
Browse path of attribute operand | < string > array |
| dataType optional |
Data type if operand is a literal | string |
| index optional |
Element reference in the outer list if operand is an element operand |
integer (int64) |
| indexRange optional |
Index range of attribute operand | string |
| nodeId optional |
Type definition node id if operand is simple or full attribute operand. |
string |
| value optional |
Variant value if operand is a literal | object |
FilterOperatorType
Filter operator type
Type : enum (Equals, IsNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Like, Not, Between, InList, And, Or, Cast, InView, OfType, RelatedTo, BitwiseAnd, BitwiseOr)
GetConfiguredEndpointsResponseModel
Result of GetConfiguredEndpoints method call
| Name | Description | Schema |
|---|---|---|
| endpoints optional |
Collection of Endpoints in the configuration | < PublishedNodesEntryModel > array |
GetConfiguredNodesOnEndpointResponseModel
Result of GetConfiguredNodesOnEndpoint method call
| Name | Description | Schema |
|---|---|---|
| opcNodes optional |
Collection of Nodes configured for a particular endpoint | < OpcNodeModel > array |
HeartbeatBehavior
Controls how heartbeat messages are handled for monitored items. Heartbeats help maintain awareness of node state and connection health even when values don’t change. Can be configured globally via the –hbb command line option. Works with heartbeat interval settings.
Type : enum (WatchdogLKV, WatchdogLKG, PeriodicLKV, PeriodicLKG, WatchdogLKVWithUpdatedTimestamps, WatchdogLKVDiagnosticsOnly, Reserved, PeriodicLKVDropValue, PeriodicLKGDropValue)
HistoricEventModel
Historic event
| Name | Description | Schema |
|---|---|---|
| eventFields required |
The selected fields of the event | object |
HistoricEventModelArrayHistoryReadNextResponseModel
History read continuation result
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| history required |
History as json encoded extension object | < HistoricEventModel > array |
HistoricEventModelArrayHistoryReadResponseModel
History read results
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| history required |
History as json encoded extension object | < HistoricEventModel > array |
HistoricEventModelIAsyncEnumerable
Type : object
HistoricValueModel
Historic data
| Name | Description | Schema |
|---|---|---|
| additionalData optional |
AdditionalData | |
| dataLocation optional |
DataLocation | |
| dataType optional |
Built in data type of the updated values | string |
| modificationInfo optional |
ModificationInfoModel | |
| serverPicoseconds optional |
Additional resolution for the server timestamp. | integer (int32) |
| serverTimestamp optional |
The server timestamp associated with the value. | string (date-time) |
| sourcePicoseconds optional |
Additional resolution for the source timestamp. | integer (int32) |
| sourceTimestamp optional |
The source timestamp associated with the value. | string (date-time) |
| status optional |
ServiceResultModel | |
| value optional |
The value of data value. | object |
HistoricValueModelArrayHistoryReadNextResponseModel
History read continuation result
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| history required |
History as json encoded extension object | < HistoricValueModel > array |
HistoricValueModelArrayHistoryReadResponseModel
History read results
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| history required |
History as json encoded extension object | < HistoricValueModel > array |
HistoricValueModelIAsyncEnumerable
Type : object
HistoryConfigurationModel
History configuration
| Name | Description | Schema |
|---|---|---|
| aggregateConfiguration optional |
AggregateConfigurationModel | |
| aggregateFunctions optional |
Allowed aggregate functions | < string, string > map |
| definition optional |
Human readable string that specifies how the value of this HistoricalDataNode is calculated |
string |
| endOfArchive optional |
The last date of the archive | string (date-time) |
| exceptionDeviation optional |
Minimum amount that the data for the Node shall change in order for the change to be reported to the history database |
number (double) |
| exceptionDeviationType optional |
ExceptionDeviationType | |
| maxTimeInterval optional |
Specifies the maximum interval between data points in the history repository regardless of their value change |
string (date-span) |
| minTimeInterval optional |
Specifies the minimum interval between data points in the history repository regardless of their value change |
string (date-span) |
| serverTimestampSupported optional |
Server supports ServerTimestamps in addition to SourceTimestamp |
boolean |
| startOfArchive optional |
The date before which there is no data in the archive either online or offline |
string (date-time) |
| startOfOnlineArchive optional |
Date of the earliest data in the online archive | string (date-time) |
| stepped optional |
specifies whether the historical data was collected in such a manner that it should be displayed as SlopedInterpolation (sloped line between points) or as SteppedInterpolation (vertically-connected horizontal lines between points) when raw data is examined. This Property also effects how some Aggregates are calculated |
boolean |
HistoryConfigurationRequestModel
Request history configuration
| Name | Description | Schema |
|---|---|---|
| header optional |
RequestHeaderModel | |
| nodeId required |
Continuation token to continue reading more results. Minimum length : 1 |
string |
HistoryConfigurationRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
HistoryConfigurationRequestModel |
HistoryConfigurationResponseModel
Response with history configuration
| Name | Schema |
|---|---|
| configuration optional |
HistoryConfigurationModel |
| errorInfo optional |
ServiceResultModel |
HistoryReadNextRequestModel
Request node history read continuation
| Name | Description | Schema |
|---|---|---|
| abort optional |
Abort reading after this read | boolean |
| continuationToken required |
Continuation token to continue reading more results. Minimum length : 1 |
string |
| header optional |
RequestHeaderModel |
HistoryReadNextRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
HistoryReadNextRequestModel |
HistoryServerCapabilitiesModel
History Server capabilities
| Name | Description | Schema |
|---|---|---|
| aggregateFunctions optional |
Supported aggregate functions | < string, string > map |
| deleteAtTimeCapability optional |
Server support deleting data at times | boolean |
| deleteEventCapability optional |
Server supports deleting events | boolean |
| deleteRawCapability optional |
Server supports deleting raw data | boolean |
| insertAnnotationCapability optional |
Allows inserting annotations | boolean |
| insertDataCapability optional |
Server supports inserting data | boolean |
| insertEventCapability optional |
Server supports inserting events | boolean |
| maxReturnDataValues optional |
Maximum number of historic data values that will be returned in a single read. |
integer (int64) |
| maxReturnEventValues optional |
Maximum number of events that will be returned in a single read. |
integer (int64) |
| replaceDataCapability optional |
Server supports replacing historic data | boolean |
| replaceEventCapability optional |
Server supports replacing events | boolean |
| serverTimestampSupported optional |
Server supports ServerTimestamps in addition to SourceTimestamp |
boolean |
| supportsHistoricData optional |
Server supports historic data access | boolean |
| supportsHistoricEvents optional |
Server supports historic event access | boolean |
| updateDataCapability optional |
Server supports updating historic data | boolean |
| updateEventCapability optional |
Server supports updating events | boolean |
HistoryUpdateOperation
History update type
Type : enum (Insert, Replace, Update, Delete)
HistoryUpdateResponseModel
History update results
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| results optional |
List of results from the update operation | < ServiceResultModel > array |
InstanceDeclarationModel
Instance declaration meta data
| Name | Description | Schema |
|---|---|---|
| browseName optional |
The browse name for the instance declaration. | string |
| browsePath optional |
The browse path | < string > array |
| description optional |
The description for the instance declaration. | string |
| displayName optional |
The display name for the instance declaration. | string |
| displayPath optional |
A localized path to the instance declaration. | string |
| method optional |
MethodMetadataModel | |
| modellingRule optional |
The modelling rule for the instance declaration (i.e. Mandatory or Optional). |
string |
| modellingRuleId optional |
The modelling rule node id. | string |
| nodeClass optional |
NodeClass | |
| nodeId optional |
The node id for the instance. | string |
| overriddenDeclaration optional |
InstanceDeclarationModel | |
| rootTypeId optional |
The type that the declaration belongs to. | string |
| variable optional |
VariableMetadataModel |
MessageEncoding
Specifies the encoding format for OPC UA Publisher messages. Can be combined with compression and reversibility flags to control message format characteristics.
Type : enum (Uadp, Json, Xml, Avro, IsReversible, JsonReversible, IsGzipCompressed, JsonGzip, AvroGzip, JsonReversibleGzip)
MessagingMode
Defines how OPC UA Publisher formats and structures messages for transport. Each mode provides different trade-offs between message completeness, bandwidth efficiency, and compatibility with different message consumers.
Type : enum (PubSub, Samples, FullNetworkMessages, FullSamples, DataSetMessages, SingleDataSetMessage, DataSets, SingleDataSet, RawDataSets, SingleRawDataSet)
MethodCallArgumentModel
Method argument model
| Name | Description | Schema |
|---|---|---|
| dataType optional |
Data type Id of the value (from meta data) | string |
| value optional |
Initial value or value to use | object |
MethodCallRequestModel
Call request model
| Name | Description | Schema |
|---|---|---|
| arguments optional |
Arguments for the method - null means no args | < MethodCallArgumentModel > array |
| header optional |
RequestHeaderModel | |
| methodBrowsePath optional |
An optional component path from the node identified by MethodId or from a resolved objectId to the actual method node. |
< string > array |
| methodId optional |
Method id of method to call. | string |
| objectBrowsePath optional |
An optional component path from the node identified by ObjectId to the actual object or objectType node. If ObjectId is null, the root node (i=84) is used |
< string > array |
| objectId optional |
Context of the method, i.e. an object or object type node. If null then the method is called in the context of the inverse HasComponent reference of the MethodId if it exists. |
string |
MethodCallRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
MethodCallRequestModel |
MethodCallResponseModel
Method call response model
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| results required |
Resulting output values of method call | < MethodCallArgumentModel > array |
MethodMetadataArgumentModel
Method argument metadata model
| Name | Description | Schema |
|---|---|---|
| arrayDimensions optional |
Optional Array dimension of argument | integer (int64) |
| defaultValue optional |
Default value for the argument | object |
| description optional |
Optional description of argument | string |
| errorInfo optional |
ServiceResultModel | |
| name required |
Name of the argument | string |
| type required |
NodeModel | |
| valueRank optional |
NodeValueRank |
MethodMetadataModel
Method metadata model
| Name | Description | Schema |
|---|---|---|
| inputArguments optional |
Input argument meta data | < MethodMetadataArgumentModel > array |
| objectId optional |
Id of object that the method is a component of | string |
| outputArguments optional |
output argument meta data | < MethodMetadataArgumentModel > array |
MethodMetadataRequestModel
Method metadata request model
| Name | Description | Schema |
|---|---|---|
| header optional |
RequestHeaderModel | |
| methodBrowsePath optional |
An optional component path from the node identified by MethodId to the actual method node. |
< string > array |
| methodId optional |
Method id of method to call. (Required) |
string |
MethodMetadataRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
MethodMetadataRequestModel |
MethodMetadataResponseModel
Result of method metadata query
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| inputArguments optional |
Input argument meta data | < MethodMetadataArgumentModel > array |
| objectId optional |
Id of object that the method is a component of | string |
| outputArguments optional |
output argument meta data | < MethodMetadataArgumentModel > array |
ModelChangeHandlingOptionsModel
Describes how model changes are published
| Name | Description | Schema |
|---|---|---|
| rebrowseIntervalTimespan optional |
Rebrowse period | string (date-span) |
ModificationInfoModel
Modification information
| Name | Description | Schema |
|---|---|---|
| modificationTime optional |
Modification time | string (date-time) |
| updateType optional |
HistoryUpdateOperation | |
| userName optional |
User who made the change | string |
MonitoredItemWatchdogCondition
Defines the conditions that trigger the subscription watchdog behavior. Works in conjunction with OpcNodeWatchdogTimespan to determine when nodes are considered “late” and DataSetWriterWatchdogBehavior to define the response. Can be configured globally via the –mwc command line option.
Type : enum (WhenAllAreLate, WhenAnyIsLate)
NamespaceFormat
Namespace serialization format for node ids and qualified names.
Type : enum (Uri, Index, Expanded, ExpandedWithNamespace0)
NodeAccessLevel
Flags that can be set for the AccessLevel attribute.
Type : enum (None, CurrentRead, CurrentWrite, HistoryRead, HistoryWrite, SemanticChange, StatusWrite, TimestampWrite, NonatomicRead, NonatomicWrite, WriteFullArrayOnly)
NodeAccessRestrictions
Flags that can be read or written in the AccessRestrictions attribute.
Type : enum (None, SigningRequired, EncryptionRequired, SessionRequired)
NodeAttribute
Node attribute identifiers
Type : enum (NodeId, NodeClass, BrowseName, DisplayName, Description, WriteMask, UserWriteMask, IsAbstract, Symmetric, InverseName, ContainsNoLoops, EventNotifier, Value, DataType, ValueRank, ArrayDimensions, AccessLevel, UserAccessLevel, MinimumSamplingInterval, Historizing, Executable, UserExecutable, DataTypeDefinition, RolePermissions, UserRolePermissions, AccessRestrictions)
NodeClass
Node class
Type : enum (Object, Variable, Method, ObjectType, VariableType, ReferenceType, DataType, View)
NodeEventNotifier
Flags that can be set for the EventNotifier attribute.
Type : enum (SubscribeToEvents, HistoryRead, HistoryWrite)
NodeIdModel
Represents an OPC UA Node identifier in string format. Used to identify nodes in the OPC UA address space for monitoring. Supports standard OPC UA node ID formats including:
- Namespace index and identifier (ns=0;i=85)
- String identifiers (ns=2;s=MyNode)
- GUID identifiers (ns=3;g=8599E6C4-6667-4FB7-9EA9-C6896B31DB02)
- Opaque/binary identifiers (ns=4;b=FA34E…)
| Name | Description | Schema |
|---|---|---|
| Identifier optional |
The node identifier string in standard OPC UA notation. Format: ns={namespace};{type}={value} Examples: - ns=0;i=85 (numeric identifier) - ns=2;s=MyNode (string identifier) - ns=3;g=8599E6C4-6667-4FB7-9EA9-C6896B31DB02 (GUID) - ns=4;b=FA34E… (binary/opaque) If namespace index is omitted, ns=0 is assumed. |
string |
NodeMetadataRequestModel
Node metadata request model
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional component path from the node identified by NodeId to the actual node. |
< string > array |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node id of the type. (Required) |
string |
NodeMetadataRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
NodeMetadataRequestModel |
NodeMetadataResponseModel
Node metadata model
| Name | Description | Schema |
|---|---|---|
| dataTypeMetadata optional |
DataTypeMetadataModel | |
| description optional |
The description for the node. | string |
| displayName optional |
The display name of the node. | string |
| errorInfo optional |
ServiceResultModel | |
| nethodMetadata optional |
MethodMetadataModel | |
| nodeClass optional |
NodeClass | |
| nodeId optional |
The node id of the node | string |
| typeDefinition optional |
TypeDefinitionModel | |
| variableMetadata optional |
VariableMetadataModel |
NodeModel
Node model
| Name | Description | Schema |
|---|---|---|
| accessLevel optional |
NodeAccessLevel | |
| accessRestrictions optional |
NodeAccessRestrictions | |
| arrayDimensions optional |
Array dimensions of variable or variable type. (default: empty array) |
integer (int64) |
| browseName optional |
Browse name | string |
| children optional |
Whether node has children which are defined as any forward hierarchical references. (default: unknown) |
boolean |
| containsNoLoops optional |
Whether a view contains loops. Null if not a view. |
boolean |
| dataType optional |
If variable the datatype of the variable. (default: null) |
string |
| dataTypeDefinition optional |
Data type definition in case node is a data type node and definition is available, otherwise null. |
object |
| description optional |
Description if any | string |
| displayName optional |
Display name | string |
| errorInfo optional |
ServiceResultModel | |
| eventNotifier optional |
NodeEventNotifier | |
| executable optional |
If method node class, whether method can be called. |
boolean |
| historizing optional |
Whether the value of a variable is historizing. (default: false) |
boolean |
| inverseName optional |
Inverse name of the reference if the node is a reference type, otherwise null. |
string |
| isAbstract optional |
Whether type is abstract, if type can be abstract. Null if not type node. (default: false) |
boolean |
| minimumSamplingInterval optional |
Minimum sampling interval for the variable value, otherwise null if not a variable node. (default: null) |
number (double) |
| nodeClass optional |
NodeClass | |
| nodeId required |
Id of node. (Mandatory). Minimum length : 1 |
string |
| rolePermissions optional |
Role permissions | < RolePermissionModel > array |
| serverPicoseconds optional |
Pico seconds part of when value was read at server. | integer (int32) |
| serverTimestamp optional |
Timestamp of when value was read at server. | string (date-time) |
| sourcePicoseconds optional |
Pico seconds part of when value was read at source. | integer (int32) |
| sourceTimestamp optional |
Timestamp of when value was read at source. | string (date-time) |
| symmetric optional |
Whether the reference is symmetric in case the node is a reference type, otherwise null. |
boolean |
| typeDefinitionId optional |
Optional type definition of the node | string |
| userAccessLevel optional |
NodeAccessLevel | |
| userExecutable optional |
If method node class, whether method can be called by current user. (default: false if not executable) |
boolean |
| userRolePermissions optional |
User Role permissions | < RolePermissionModel > array |
| userWriteMask optional |
User write mask for the node (default: 0) |
integer (int64) |
| value optional |
Value of variable or default value of the subtyped variable in case node is a variable type, otherwise null. |
object |
| valueRank optional |
NodeValueRank | |
| writeMask optional |
Default write mask for the node (default: 0) |
integer (int64) |
NodePathTargetModel
Node path target
| Name | Description | Schema |
|---|---|---|
| browsePath required |
The target browse path | < string > array |
| remainingPathIndex optional |
Remaining index in path | integer (int32) |
| target required |
NodeModel |
NodeReferenceModel
Reference model
| Name | Description | Schema |
|---|---|---|
| direction optional |
BrowseDirection | |
| errorInfo optional |
ServiceResultModel | |
| referenceTypeId optional |
Reference Type id | string |
| target required |
NodeModel |
NodeType
The node type
Type : enum (Unknown, Variable, DataVariable, Property, DataType, View, Object, Event, Interface)
NodeValueRank
Constants defined for the ValueRank attribute.
Type : enum (OneOrMoreDimensions, OneDimension, TwoDimensions, ScalarOrOneDimension, Any, Scalar)
OpcAuthenticationMode
Specifies the authentication method used to connect to OPC UA servers. The chosen mode determines how the Publisher authenticates itself to servers. When using credentials or certificates, encrypted communication should be enabled via UseSecurity or EndpointSecurityMode to protect authentication secrets.
Type : enum (Anonymous, UsernamePassword, Certificate)
OpcNodeModel
Defines configuration for monitoring an OPC UA node. Contains settings for sampling, filtering, publishing behavior, and message routing. This model allows fine-grained control over how each node’s data is collected and transmitted. Part of a PublishedNodesEntryModel’s OpcNodes collection.
| Name | Description | Schema |
|---|---|---|
| AttributeId optional |
NodeAttribute | |
| BrowsePath optional |
Relative path through the address space to reach target node. Sequence of browse names from starting node to target. Example: [“Objects”, “Server”, “Data”, “Dynamic”, “Scalar”]. Allows referencing nodes through hierarchical structure. Alternative to direct node ID addressing. |
< string > array |
| ConditionHandling optional |
ConditionHandlingOptionsModel | |
| CyclicReadMaxAge optional |
Maximum age for cached values in cyclic reads. Specified in milliseconds. Default: 0 (no caching) Only applies when UseCyclicRead is true. Server may return cached value if within max age. Helps reduce server load in high-frequency reads. Ignored when CyclicReadMaxAgeTimespan is defined. |
integer (int32) |
| CyclicReadMaxAgeTimespan optional |
Maximum age for cached values in cyclic reads as TimeSpan. Takes precedence over CyclicReadMaxAge if both defined. Only applies when UseCyclicRead is true. Default: “00:00:00” (no caching) Example: “00:00:00.500” for 500ms max cache age. Helps optimize read performance vs data freshness. |
string (date-span) |
| DataChangeTrigger optional |
DataChangeTriggerType | |
| DataSetClassFieldId optional |
Unique identifier for correlating fields with dataset class metadata. Links monitored item data with dataset class field definitions. Used to provide context and type information for the field. Must match corresponding field ID in dataset class metadata. Important for proper message decoding by subscribers. |
string (uuid) |
| DataSetFieldId optional |
Custom identifier for this node in dataset messages. Used as field name in message payloads if specified. Falls back to DisplayName if not provided. Helps correlate data with specific measurements or tags. Must be unique within a dataset writer. |
string |
| DeadbandType optional |
DeadbandType | |
| DeadbandValue optional |
Deadband value of the data change filter to apply. Does not apply to events |
number (double) |
| DiscardNew optional |
Controls queue overflow behavior for monitored items. True: Discard newest values when queue is full (LIFO). False: Discard oldest values when queue is full (FIFO, default). Use True to preserve historical data during connection issues. Use False to maintain current value accuracy. |
boolean |
| DisplayName optional |
Human-readable name for the monitored item. Used as field identifier if DataSetFieldId not specified. Can be overridden by actual node DisplayName if FetchDisplayName=true. Helps identify data sources in messages and logs. Should be unique within a dataset for clear identification. |
string |
| EventFilter optional |
EventFilterModel | |
| ExpandedNodeId optional |
Alternative node identifier with full namespace URI. Same as Id but uses complete namespace URI instead of index. Format: “nsu={uri};{type}={value}” Example: “nsu=http://opcfoundation.org/UA/;i=2258” Provides more portable node identification across servers. |
string |
| FetchDisplayName optional |
Retrieve node’s DisplayName attribute on startup. True: Query and use actual display name False: Use configured DisplayName (default) Overrides DataSetFetchDisplayNames setting. Used for human-readable field identification. |
boolean |
| HeartbeatBehavior optional |
HeartbeatBehavior | |
| HeartbeatInterval optional |
Node-specific heartbeat interval in milliseconds. Overrides DefaultHeartbeatInterval from parent configuration. Controls how often heartbeat messages are generated. Set to 0 to disable heartbeats for this node. Ignored when HeartbeatIntervalTimespan is defined. |
integer (int32) |
| HeartbeatIntervalTimespan optional |
Node-specific heartbeat interval as TimeSpan. Takes precedence over HeartbeatInterval if both defined. Overrides DefaultHeartbeatIntervalTimespan setting. Provides more precise control over timing. Example: “00:00:10” for 10-second interval. |
string (date-span) |
| Id optional |
The OPC UA node identifier string in standard notation. Format: ns={namespace};{type}={value} Required field that uniquely identifies the node to monitor. Examples: “ns=2;s=MyTag”, “ns=0;i=2258” See OPC UA Part 3 for node ID format specifications. |
string |
| IndexRange optional |
Range specification for array or string values. Format: “start:end” or “index”. Examples: “0:3” (first 4 elements), “7” (8th element) Allows monitoring specific array elements. Default: null (entire value monitored) |
string |
| MethodMetadata optional |
MethodMetadataModel | |
| ModelChangeHandling optional |
ModelChangeHandlingOptionsModel | |
| OpcPublishingInterval optional |
Client-side publishing rate in milliseconds. Controls how often the server sends notifications. Must be >= OpcSamplingInterval for proper operation. Overrides DataSetPublishingInterval when specified. Ignored if OpcPublishingIntervalTimespan is defined. |
integer (int32) |
| OpcPublishingIntervalTimespan optional |
OpcPublishingInterval as TimeSpan. | string (date-span) |
| OpcSamplingInterval optional |
Server-side sampling rate in milliseconds. Determines how often the server checks for value changes. Default from DataSetSamplingInterval if not specified. Should be less than or equal to OpcPublishingInterval for effective sampling. Ignored when OpcSamplingIntervalTimespan is defined. |
integer (int32) |
| OpcSamplingIntervalTimespan optional |
Server-side sampling rate as a TimeSpan. Takes precedence over OpcSamplingInterval if both are defined. Provides more precise control over timing than milliseconds. Example: “00:00:00.100” for 100ms sampling. Should be less than or equal to OpcPublishingIntervalTimespan for effective sampling. |
string (date-span) |
| QualityOfService optional |
QoS | |
| QueueSize optional |
Size of the server-side queue for this monitored item. Controls how many values can be buffered during slow connections. Values are discarded according to DiscardNew when queue is full. Default is 1 unless otherwise configured. Larger queues help prevent data loss but use more server memory. |
integer (int64) |
| RegisterNode optional |
Optimize node access using RegisterNodes service. True: Register node for faster subsequent reads False: Use direct node access (default) Can improve performance for frequently accessed nodes. Server must support RegisterNodes service. |
boolean |
| SkipFirst optional |
Controls handling of initial value notification. True: Suppress first value from monitored item. False: Publish initial value (default). Useful when only changes are relevant. Server always sends initial value on creation. |
boolean |
| Topic optional |
Custom routing topic/queue for this node’s messages. Overrides writer and writer group queue settings. Enables node-specific message routing patterns. Messages are split into separate network messages when nodes have different topics. Format depends on transport (e.g., MQTT topic syntax). |
string |
| TriggeredNodes optional |
Collection of dependent nodes triggered by this node. Read atomically when parent node changes. Limited to one level of triggering (no cascading). Useful for maintaining data consistency between related measurements. Changes to triggered nodes must be made through parent node’s API calls. |
< OpcNodeModel > array |
| TypeDefinitionId optional |
A type definition id that references a well known opc ua type definition node for the variable represented by this node entry. |
string |
| UseCyclicRead optional |
Use periodic reads instead of monitored items. True: Sample using CyclicRead service calls False: Use standard subscription monitoring (default) Useful for nodes that don’t support monitoring or when consistent sampling timing is required. Consider CyclicReadMaxAge when enabled. |
boolean |
OperationContextModel
Operation log model
| Name | Description | Schema |
|---|---|---|
| AuthorityId optional |
User | string |
| Time optional |
Operation time | string (date-time) |
OperationLimitsModel
Server limits
| Name | Description | Schema |
|---|---|---|
| maxArrayLength optional |
Max array length supported | integer (int64) |
| maxBrowseContinuationPoints optional |
Max browse continuation points | integer (int32) |
| maxByteStringLength optional |
Max byte buffer length supported | integer (int64) |
| maxHistoryContinuationPoints optional |
Max history continuation points | integer (int32) |
| maxMonitoredItemsPerCall optional |
Max monitored items that can be updated at once. | integer (int64) |
| maxNodesPerBrowse optional |
Max nodes that can be part of a single browse call. | integer (int64) |
| maxNodesPerHistoryReadData optional |
Number of nodes that can be in a History Read value call | integer (int64) |
| maxNodesPerHistoryReadEvents optional |
Number of nodes that can be in a History Read events call | integer (int64) |
| maxNodesPerHistoryUpdateData optional |
Number of nodes that can be in a History Update call | integer (int64) |
| maxNodesPerHistoryUpdateEvents optional |
Number of nodes that can be in a History events update call | integer (int64) |
| maxNodesPerMethodCall optional |
Max nodes that can be read in single method call | integer (int64) |
| maxNodesPerNodeManagement optional |
Max nodes that can be added or removed in a single call. | integer (int64) |
| maxNodesPerRead optional |
Max nodes that can be read in single read call | integer (int64) |
| maxNodesPerRegisterNodes optional |
Max nodes that can be registered at once | integer (int64) |
| maxNodesPerTranslatePathsToNodeIds optional |
Max nodes that can be part of a browse path | integer (int64) |
| maxNodesPerWrite optional |
Max nodes that can be read in single write call | integer (int64) |
| maxQueryContinuationPoints optional |
Max query continuation points | integer (int32) |
| maxStringLength optional |
Max string length supported | integer (int64) |
| minSupportedSampleRate optional |
Min supported sampling rate | number (double) |
ProblemDetails
| Name | Schema |
|---|---|
| detail optional |
string |
| instance optional |
string |
| status optional |
integer (int32) |
| title optional |
string |
| type optional |
string |
PublishBulkRequestModel
Publish in bulk request
| Name | Description | Schema |
|---|---|---|
| header optional |
RequestHeaderModel | |
| nodesToAdd optional |
Node to add | < PublishedItemModel > array |
| nodesToRemove optional |
Node to remove | < string > array |
PublishBulkRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
PublishBulkRequestModel |
PublishBulkResponseModel
Result of bulk request
| Name | Description | Schema |
|---|---|---|
| nodesToAdd optional |
Node to add | < ServiceResultModel > array |
| nodesToRemove optional |
Node to remove | < ServiceResultModel > array |
PublishDiagnosticInfoModel
Model for a diagnostic info.
| Name | Description | Schema |
|---|---|---|
| connectionRetries optional |
ConnectionRetries | integer (int64) |
| encoderAvgIoTChunkUsage optional |
EncoderAvgIoTChunkUsage | number (double) |
| encoderAvgIoTMessageBodySize optional |
EncoderAvgIoTMessageBodySize | number (double) |
| encoderAvgNotificationsMessage optional |
EncoderAvgNotificationsMessage | number (double) |
| encoderIoTMessagesProcessed optional |
EncoderIoTMessagesProcessed | integer (int64) |
| encoderMaxMessageSplitRatio optional |
Encoder max message split ratio | number (double) |
| encoderNotificationsDropped optional |
EncoderNotificationsDropped | integer (int64) |
| encoderNotificationsProcessed optional |
EncoderNotificationsProcessed | integer (int64) |
| encodingBlockInputSize optional |
EncodingBlockInputSize | integer (int64) |
| encodingBlockOutputSize optional |
EncodingBlockOutputSize | integer (int64) |
| endpoints optional |
Endpoints covered by the diagnostics model. The endpoints are all part of the same writer group. Specify |
< PublishedNodesEntryModel > array |
| estimatedIoTChunksPerDay optional |
EstimatedIoTChunksPerDay | number (double) |
| ingestionDuration optional |
IngestionDuration | string (date-span) |
| ingressBatchBlockBufferSize optional |
IngressBatchBlockBufferSize | integer (int64) |
| ingressCyclicReads optional |
Number of cyclic reads of the total value changes | integer (int64) |
| ingressDataChanges optional |
IngressDataChanges | integer (int64) |
| ingressDataChangesInLastMinute optional |
Data changes received in the last minute | integer (int64) |
| ingressEventNotifications optional |
Number of incoming event notifications | integer (int64) |
| ingressEvents optional |
Total incoming events so far. | integer (int64) |
| ingressHeartbeats optional |
Number of heartbeats of the total value changes | integer (int64) |
| ingressValueChanges optional |
IngressValueChanges | integer (int64) |
| ingressValueChangesInLastMinute optional |
Value changes received in the last minute | integer (int64) |
| monitoredOpcNodesFailedCount optional |
MonitoredOpcNodesFailedCount | integer (int64) |
| monitoredOpcNodesSucceededCount optional |
MonitoredOpcNodesSucceededCount | integer (int64) |
| opcEndpointConnected optional |
OpcEndpointConnected | boolean |
| outgressInputBufferCount optional |
OutgressInputBufferCount | integer (int64) |
| outgressInputBufferDropped optional |
OutgressInputBufferDropped | integer (int64) |
| outgressIoTMessageCount optional |
OutgressIoTMessageCount | integer (int64) |
| sentMessagesPerSec optional |
SentMessagesPerSec | number (double) |
PublishStartRequestModel
Publish request
| Name | Schema |
|---|---|
| header optional |
RequestHeaderModel |
| item required |
PublishedItemModel |
PublishStartRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
PublishStartRequestModel |
PublishStartResponseModel
Result of publish request
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
PublishStopRequestModel
Unpublish request
| Name | Description | Schema |
|---|---|---|
| header optional |
RequestHeaderModel | |
| nodeId required |
Node of published item to unpublish Minimum length : 1 |
string |
PublishStopRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
PublishStopRequestModel |
PublishStopResponseModel
Result of publish stop request
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
PublishedItemListRequestModel
Request list of published items
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token or null to start | string |
| header optional |
RequestHeaderModel |
PublishedItemListRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
PublishedItemListRequestModel |
PublishedItemListResponseModel
List of published nodes
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items optional |
Monitored items | < PublishedItemModel > array |
PublishedItemModel
A monitored and published item
| Name | Description | Schema |
|---|---|---|
| displayName optional |
Display name of the variable node monitored | string |
| heartbeatInterval optional |
Heartbeat interval to use | string (date-span) |
| nodeId required |
Variable node monitored Minimum length : 1 |
string |
| publishingInterval optional |
Publishing interval to use | string (date-span) |
| samplingInterval optional |
Sampling interval to use | string (date-span) |
PublishedNodeDeleteAssetRequestModel
Contains entry in the published nodes configuration representing the asset as well as an optional request header.
| Name | Description | Schema |
|---|---|---|
| entry required |
PublishedNodesEntryModel | |
| force optional |
The asset on the server is deleted no matter whether the removal in the publisher configuration was successful or not. |
boolean |
| header optional |
RequestHeaderModel |
PublishedNodeExpansionModel
Node expansion configuration. Configures how an entry should be expanded into configuration. If a node is an object it is expanded to all contained variables.
If a node is an object type, all objects of that type are searched from the object root node. These found objects are then expanded into their variables.
If the node is a variable, the variable is expanded to include all contained variables or properties. All entries will have the data set field id configured as data set class id.
If a node is a variable type, then all variables of this type are found and added to a single writer entry. Note: That by themselves these variables are no further expanded.
| Name | Description | Schema |
|---|---|---|
| createSingleWriter optional |
By default the api will create a new distinct writer per expanded object. Objects that cannot be expanded are part of the originally provided writer. The writer id is then post fixed with the data set field id of the object node field. If true, all variables of all expanded nodes are added to the originally provided entry. |
boolean |
| discardErrors optional |
Errors are silently discarded and only successfully expanded nodes are returned. |
boolean |
| excludeRootIfInstanceNode optional |
If the node is an object or variable instance do not include it but only the instances underneath them. |
boolean |
| flattenTypeInstance optional |
If false, treats instance nodes found just like objects that need to be expanded. In case of a companion spec object type this could be set to true, flattening the structure into a single writer that represents the object in its entirety. However, when using generic interfaces that can be implemented across objects in the address space and only its variables are important, it might be useful to set this to false. |
boolean |
| header optional |
RequestHeaderModel | |
| includeMethods optional |
Include not just variables and events but also methods when expanding an object. |
boolean |
| maxDepth optional |
Max browse depth for object search operation or when searching for an instance of a type. To only expand an object to its variables set this value to 0. The depth of expansion of a variable itself can be controlled via the Azure.IIoT.OpcUa.Publisher.Models.PublishedNodeExpansionModel.MaxLevelsToExpand” property. If the root object is excluded a value of 0 is equivalent to a value of 1 to get the first level of objects contained in the object but not the object itself, e.g. a folder object. |
integer (int64) |
| maxLevelsToExpand optional |
Max number of levels to expand an instance node such as an object or variable into resulting variables. If the node is a variable instance to start with but the Azure.IIoT.OpcUa.Publisher.Models.PublishedNodeExpansionModel.ExcludeRootIfInstanceNode property is set to excluded it, then setting this value to 0 is equivalent to a value of 1 to get the first level of variables contained in the variable, but not the variable itself. Otherwise only the variable itelf is returned. If the node is an object instance, 0 is equivalent to infinite and all levels are expanded. |
integer (int64) |
| noSubTypesOfTypeNodes optional |
Do not consider subtypes of an object type when searching for instances of the type. |
boolean |
| useBrowseNameAsDisplayName optional |
Use the browse name as display name for nodes. The display name is rooted in the parent node from which browsing occurs, or just the browse name if the browse root is not a parent. |
boolean |
PublishedNodeExpansionModelPublishedNodesEntryRequestModel
Wraps a request and a published nodes entry to bind to a body more easily for api that requires an entry and additional configuration
| Name | Schema |
|---|---|
| entry required |
PublishedNodesEntryModel |
| request optional |
PublishedNodeExpansionModel |
PublishedNodesEntryModel
Configuration model for OPC UA Publisher that defines how OPC UA nodes are published to messaging systems. Used to configure connections to OPC UA servers, setup node monitoring, and control message publishing.
Key features: - Endpoint configuration and security settings - Writer group and dataset organization - Publishing intervals and sampling controls - Message batching and triggering - Subscription and monitoring options - Heartbeat and watchdog behaviors - Security modes and authentication
For detailed configuration options, see individual properties.
| Name | Description | Schema |
|---|---|---|
| BatchSize optional |
The number of notifications that are queued before a network message is generated. Controls message batching for optimizing network traffic vs latency. For historic reasons the default value is 50 unless otherwise configured via the –bs command line option. |
integer (int64) |
| BatchTriggerInterval optional |
The interval at which batched network messages are published, in milliseconds. Messages are published when this interval elapses or when BatchSize is reached. For historic reasons the default is 10 seconds unless configured via –bi. Ignored when BatchTriggerIntervalTimespan is specified. Used with BatchSize to optimize network traffic vs latency. |
integer (int32) |
| BatchTriggerIntervalTimespan optional |
The interval at which batched network messages are published, as a TimeSpan. Takes precedence over BatchTriggerInterval if both are defined. Messages are published when this interval elapses or when BatchSize is reached. Provides more precise control over publishing timing than millisecond interval. Used with BatchSize to optimize network traffic vs latency. |
string (date-span) |
| DataSetClassId optional |
The optional dataset class id as it shall appear in dataset messages and dataset metadata. Used to uniquely identify the type of dataset being published. Default: Guid.Empty |
string (uuid) |
| DataSetDescription optional |
The optional description of the dataset. | string |
| DataSetExtensionFields optional |
Optional key-value pairs inserted into key frame and metadata messages in the same data set. Values are formatted using OPC UA Variant JSON encoding. Used to add contextual information to datasets. |
< string, object > map |
| DataSetFetchDisplayNames optional |
Controls whether to fetch display names of monitored variable nodes and use those inside messages as field names. When true, fetches display names for all nodes. If false, uses DisplayName value if provided; if not provided, uses the node id. Can be configured via –fd command line option. |
boolean |
| DataSetKeyFrameCount optional |
Controls key frame insertion frequency in the message stream. A key frame contains all current values, while delta frames only contain changes. Setting this ensures periodic complete state updates, useful for late-joining consumers or state synchronization. Key frames can also include configured DataSetExtensionFields for additional context. Default: 0 (key frames disabled) |
integer (int64) |
| DataSetName optional |
The optional name of the dataset as it will appear in the dataset metadata. Used for identification and organization of datasets. |
string |
| DataSetPublishingInterval optional |
The publishing interval used for a grouped set of nodes under a certain DataSetWriter, expressed in milliseconds. When a specific node underneath DataSetWriter defines OpcPublishingInterval (or Timespan), its value will overwrite this interval and potentially split the data set writer into more than one subscription. Ignored when DataSetPublishingIntervalTimespan is present. |
integer (int32) |
| DataSetPublishingIntervalTimespan optional |
The publishing interval for a dataset writer, expressed as a TimeSpan value. Takes precedence over DataSetPublishingInterval if defined. Provides more precise control over timing than milliseconds. When overridden by node-specific intervals, the writer may split into multiple subscriptions. |
string (date-span) |
| DataSetRootNodeId optional |
A root node that all nodes that use a non rooted browse paths in the dataset should start from. |
string |
| DataSetRouting optional |
DataSetRoutingMode | |
| DataSetSamplingInterval optional |
Default sampling interval in milliseconds for all monitored items in the dataset. Used if individual nodes don’t specify their own sampling interval. Follows OPC UA specification for sampling behavior. Ignored when DataSetSamplingIntervalTimespan is present. Defaults to value configured via –oi command line option. |
integer (int32) |
| DataSetSamplingIntervalTimespan optional |
Default sampling interval as TimeSpan for all monitored items in the dataset. Takes precedence over DataSetSamplingInterval if both are defined. Used if individual nodes don’t specify their own sampling interval. Provides more precise control over sampling timing. Follows OPC UA specification for sampling behavior. |
string (date-span) |
| DataSetSourceUri optional |
Contains an uri identifier that allows correlation of the writer data set source into other systems. Will be used as part of cloud events header if enabled. |
string |
| DataSetSubject optional |
Contains an identifier that allows correlation of the writer group into other systems in the context of the source. Will be used as part of cloud events header if enabled. |
string |
| DataSetType optional |
A type definition id that references a well known opc ua type definition node for the dataset represented by this entry. If set it is used in context of cloud events to specify a concrete type of dataset message in the cloud events type header. |
string |
| DataSetWriterGroup optional |
The data set writer group collecting datasets defined for a certain endpoint. This attribute is used to identify the session opened into the server. The default value consists of the EndpointUrl string, followed by a deterministic hash composed of the EndpointUrl, UseSecurity, OpcAuthenticationMode, UserName and Password attributes. |
string |
| DataSetWriterId optional |
The unique identifier for a data set writer used to collect OPC UA nodes to be semantically grouped and published with the same publishing interval. When not specified, uses a string representing the common publishing interval of the nodes in the data set collection. This attribute uniquely identifies a data set within a DataSetWriterGroup. The uniqueness is determined using the provided DataSetWriterId and the publishing interval of the grouped OpcNodes. |
string |
| DataSetWriterWatchdogBehavior optional |
SubscriptionWatchdogBehavior | |
| DefaultHeartbeatBehavior optional |
HeartbeatBehavior | |
| DefaultHeartbeatInterval optional |
The interval in milliseconds at which to publish heartbeat messages. Heartbeat acts like a watchdog that fires after this interval has passed and no new value has been received. A value of 0 disables heartbeat. Ignored when DefaultHeartbeatIntervalTimespan is defined. See heartbeat.md for detailed behavior documentation. |
integer (int32) |
| DefaultHeartbeatIntervalTimespan optional |
The heartbeat interval as TimeSpan for all nodes in this dataset. Takes precedence over DefaultHeartbeatInterval if defined. Controls how often heartbeat messages are published when no value changes occur. |
string (date-span) |
| DisableSubscriptionTransfer optional |
Controls whether subscription transfer is disabled during reconnect. When false (default), attempts to transfer subscriptions on reconnect to maintain data continuity. Set to true to fix interoperability issues with servers that don’t support subscription transfer. Can be configured globally via command line options. |
boolean |
| DumpConnectionDiagnostics optional |
Enables detailed server diagnostics logging for the connection. When enabled, provides additional diagnostic information useful for troubleshooting connectivity, authentication, and subscription issues. The diagnostics data is included in the publisher’s logs. Default: false |
boolean |
| EncryptedAuthPassword optional |
The encrypted password for authentication when OpcAuthenticationMode is UsernamePassword. For certificate authentication, contains the password to access the private key. Encrypted credentials at rest can be enforced using the –fce command line option. Version 2.6+ stores credentials in plain text by default, while 2.5 and below always encrypted them. |
string |
| EncryptedAuthUsername optional |
The encrypted username for authentication when OpcAuthenticationMode is UsernamePassword. Encrypted credentials at rest can be enforced using the –fce command line option. Version 2.6+ stores credentials in plain text by default, while 2.5 and below always encrypted them. |
string |
| EndpointSecurityMode optional |
SecurityMode | |
| EndpointSecurityPolicy optional |
The security policy URI to use for the endpoint connection. Overrides UseSecurity setting and refines EndpointSecurityMode choice. Examples include “http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256”. If the specified policy is not available with the chosen security mode, connectivity will fail. This allows enforcing specific security requirements. |
string |
| EndpointUrl required |
The required OPC UA server endpoint URL to connect to. This is the only required field in the configuration. Format: “opc.tcp://host:port/path” Minimum length : 1 |
string |
| LastChangeDateTime optional |
The time the Publisher configuration was last updated. Read only and informational only. |
string (date-time) |
| MaxKeepAliveCount optional |
Defines how many publishing timer expirations to wait before sending a keep-alive message when no notifications are pending. Works with SendKeepAliveDataSetMessages to maintain connection awareness. Keep-alive messages help detect connection issues even when no data changes are occurring. |
integer (int64) |
| MessageEncoding optional |
MessageEncoding | |
| MessageRetention optional |
Controls message retention for this specific writer. Overrides WriterGroupMessageRetention at the individual writer level. Only applied if the transport technology supports retention. Together with QueueName, allows splitting messages across different queues with different retention policies. |
boolean |
| MessageTtlTimespan optional |
Time-to-live duration for messages sent by this specific writer. Overrides WriterGroupMessageTtlTimespan at the individual writer level. Only applied if the transport technology supports message TTL. Allows different TTL settings for different types of data. |
string (date-span) |
| MessagingMode optional |
MessagingMode | |
| MetaDataQueueName optional |
The queue name to use for metadata messages from this writer. Overrides the default metadata topic template. Allows routing metadata to specific destinations separate from data messages. |
string |
| MetaDataRetention optional |
Metadata retention setting for the dataset writer. | boolean |
| MetaDataTtlTimespan optional |
Metadata time-to-live duration for the dataset writer. | string (date-span) |
| MetaDataUpdateTime optional |
The interval in milliseconds at which metadata messages are sent, even when the metadata has not changed. Only applies when metadata messaging is supported or explicitly enabled. Ignored when MetaDataUpdateTimeTimespan is defined. |
integer (int32) |
| MetaDataUpdateTimeTimespan optional |
The interval as TimeSpan at which metadata messages are sent, even when metadata has not changed. Takes precedence over MetaDataUpdateTime if both are defined. Only applies when metadata messaging is supported or explicitly enabled. |
string (date-span) |
| NodeId optional |
NodeIdModel | |
| OpcAuthenticationMode optional |
OpcAuthenticationMode | |
| OpcAuthenticationPassword optional |
The plaintext password for UsernamePassword authentication, or the password protecting the private key for Certificate authentication. For Certificate mode, this must match the password used when adding the certificate to the PKI store. |
string |
| OpcAuthenticationUsername optional |
The plaintext username for UsernamePassword authentication, or the subject name of the certificate for Certificate authentication. When using Certificate mode, this refers to a certificate in the User certificate store of the PKI configuration. |
string |
| OpcNodeWatchdogCondition optional |
MonitoredItemWatchdogCondition | |
| OpcNodeWatchdogTimespan optional |
The timeout duration used to monitor whether monitored items in the subscription are continuously reporting fresh data. This watchdog mechanism helps detect stale data or connectivity issues. When this timeout expires, the configured DataSetWriterWatchdogBehavior is triggered based on OpcNodeWatchdogCondition. Expressed as a TimeSpan value. |
string (date-span) |
| OpcNodes optional |
The DataSet collection grouping the nodes to be published for the specific DataSetWriter. Each node can specify monitoring parameters including sampling intervals, deadband settings, and event filtering options. Contains variable nodes or event notifiers to monitor. |
< OpcNodeModel > array |
| Priority optional |
Priority of the writer subscription. | integer (int32) |
| PublisherId optional |
Set a publisher id to use that is different form the global publisher identity. |
string |
| QualityOfService optional |
QoS | |
| QueueName optional |
Overrides the writer group queue name at the individual writer level. When specified, causes network messages to be split across different queues. The split also takes QoS settings into account, allowing fine-grained control over message routing and delivery guarantees. |
string |
| RepublishAfterTransfer optional |
Controls whether to republish missed values after a subscription is transferred during reconnect handling. Only applies when DisableSubscriptionTransfer is false. Helps ensure no data is lost during connection interruptions. Default: true |
boolean |
| SendKeepAliveAsKeyFrameMessages optional |
When sending of keep alive messages is enabled, this flag controls whether the keep alive messages are sent as key frames. Key frames contain all current values. |
boolean |
| SendKeepAliveDataSetMessages optional |
Controls whether to send keep alive messages for this dataset when a subscription keep alive notification is received. Keep alive messages help maintain connection status awareness. Only valid if the messaging mode supports keep alive messages. Default: false |
boolean |
| UseReverseConnect optional |
Use reverse connect to connect ot the endpoint | boolean |
| UseSecurity optional |
Controls whether to use a secure OPC UA transport mode to establish a session. When true, defaults to SecurityMode.NotNone which requires signed or encrypted communication. When false, uses SecurityMode.None with no security. Can be overridden by EndpointSecurityMode and EndpointSecurityPolicy settings. Use encrypted communication whenever possible to protect credentials and data. |
boolean |
| Version optional |
A monotonically increasing number identifying the change version. At this point the version number is informational only, but should be provided in API requests if available. Not used inside file based configuration. |
integer (int64) |
| WriterGroupMessageRetention optional |
Controls whether messages should be retained by the messaging system. Only applied if the transport technology supports message retention. When true, messages are kept by the broker even after delivery. Useful for late-joining subscribers to receive the last known values. |
boolean |
| WriterGroupMessageTtlTimepan optional |
Time-to-live duration for messages sent through the writer group. Only applied if the transport technology supports message TTL. After this duration expires, messages may be discarded by the messaging system. Used to prevent stale data from being processed by consumers. |
string (date-span) |
| WriterGroupPartitions optional |
Specifies how many partitions to split the writer group into when publishing to target topics. Used to distribute message load and enable parallel processing by consumers. Default is 1 partition. Particularly useful for high-throughput scenarios or when using partitioned queues/topics in the messaging system. |
integer (int32) |
| WriterGroupProperties optional |
Additional properties of the writer group that should be retained with the configuration. |
< string, object > map |
| WriterGroupQualityOfService optional |
QoS | |
| WriterGroupQueueName optional |
Overrides the default writer group topic template for message routing. Used to customize where messages from this writer group are published. Particularly useful when publishing to MQTT topics or message queues where specific routing patterns are needed. |
string |
| WriterGroupRootNodeId optional |
A node that represents the writer group in the server address space. This is the instance id of the root node from which all datasets originate. It is informational only and would not need to be configured |
string |
| WriterGroupTransport optional |
WriterGroupTransport | |
| WriterGroupTransportConfiguration optional |
Pass connection string for the transport layer. This works for transports that support connection strings such as IoT Hub or Event Hubs. It enables overriding the default connection string configured for the publisher. The transport must be configured using the command line options first, and can be overriden here. If it is not configured on the command line first, the setting here is ignored. |
string |
| WriterGroupType optional |
A type that is attached to the writer group and explains the shape of the writer group. It is the type definition id of the writer group root node id. It is informational only and would not need to be configured |
string |
PublishedNodesEntryModelServiceResponse
Response envelope
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
| result optional |
PublishedNodesEntryModel |
PublishedNodesEntryModelServiceResponseIAsyncEnumerable
Type : object
PublishedNodesResponseModel
PublishNodes direct method response
Type : object
QoS
Type : enum (AtMostOnce, AtLeastOnce, ExactlyOnce)
QueryCompilationRequestModel
Query compiler request model
| Name | Description | Schema |
|---|---|---|
| header optional |
RequestHeaderModel | |
| query required |
The query to compile. Minimum length : 1 |
string |
| queryType optional |
QueryType |
QueryCompilationRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
QueryCompilationRequestModel |
QueryCompilationResponseModel
Query compiler response model
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
| eventFilter optional |
EventFilterModel |
QueryType
Query type
Type : enum (Event, Query)
ReadEventsDetailsModel
Read event data
| Name | Description | Schema |
|---|---|---|
| endTime optional |
End time to read to | string (date-time) |
| filter optional |
EventFilterModel | |
| numEvents optional |
Number of events to read | integer (int64) |
| startTime optional |
Start time to read from | string (date-time) |
ReadEventsDetailsModelHistoryReadRequestModel
Request node history read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
ReadEventsDetailsModel | |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| nodeId optional |
Node to read from (mandatory without browse path) | string |
| timestampsToReturn optional |
TimestampsToReturn |
ReadEventsDetailsModelHistoryReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ReadEventsDetailsModelHistoryReadRequestModel |
ReadModifiedValuesDetailsModel
Read modified data
| Name | Description | Schema |
|---|---|---|
| endTime optional |
The end time to read to | string (date-time) |
| numValues optional |
The number of values to read | integer (int64) |
| startTime optional |
The start time to read from | string (date-time) |
ReadModifiedValuesDetailsModelHistoryReadRequestModel
Request node history read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
ReadModifiedValuesDetailsModel | |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| nodeId optional |
Node to read from (mandatory without browse path) | string |
| timestampsToReturn optional |
TimestampsToReturn |
ReadModifiedValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ReadModifiedValuesDetailsModelHistoryReadRequestModel |
ReadProcessedValuesDetailsModel
Read processed historic data
| Name | Description | Schema |
|---|---|---|
| aggregateConfiguration optional |
AggregateConfigurationModel | |
| aggregateType optional |
The aggregate type to apply. Can be the name of the aggregate if available in the history server capabilities, or otherwise will be used as a node id referring to the aggregate. |
string |
| endTime optional |
End time to read until | string (date-time) |
| processingInterval optional |
Interval to process | string (date-span) |
| startTime optional |
Start time to read from. | string (date-time) |
ReadProcessedValuesDetailsModelHistoryReadRequestModel
Request node history read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
ReadProcessedValuesDetailsModel | |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| nodeId optional |
Node to read from (mandatory without browse path) | string |
| timestampsToReturn optional |
TimestampsToReturn |
ReadProcessedValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ReadProcessedValuesDetailsModelHistoryReadRequestModel |
ReadRequestModel
Request node attribute read
| Name | Description | Schema |
|---|---|---|
| attributes required |
Attributes to read | < AttributeReadRequestModel > array |
| header optional |
RequestHeaderModel |
ReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ReadRequestModel |
ReadResponseModel
Result of attribute reads
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| results required |
All results of attribute reads | < AttributeReadResponseModel > array |
ReadValuesAtTimesDetailsModel
Read data at specified times
| Name | Description | Schema |
|---|---|---|
| reqTimes required |
Requested datums | < string (date-time) > array |
| useSimpleBounds optional |
Whether to use simple bounds | boolean |
ReadValuesAtTimesDetailsModelHistoryReadRequestModel
Request node history read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
ReadValuesAtTimesDetailsModel | |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| nodeId optional |
Node to read from (mandatory without browse path) | string |
| timestampsToReturn optional |
TimestampsToReturn |
ReadValuesAtTimesDetailsModelHistoryReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ReadValuesAtTimesDetailsModelHistoryReadRequestModel |
ReadValuesDetailsModel
Read historic values
| Name | Description | Schema |
|---|---|---|
| endTime optional |
End of period to read. Set to null if no specific end time is specified. |
string (date-time) |
| numValues optional |
The maximum number of values returned for any Node over the time range. If only one time is specified, the time range shall extend to return this number of values. 0 or null indicates that there is no maximum. |
integer (int64) |
| returnBounds optional |
Whether to return the bounding values or not. | boolean |
| startTime optional |
Beginning of period to read. Set to null if no specific start time is specified. |
string (date-time) |
ReadValuesDetailsModelHistoryReadRequestModel
Request node history read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
ReadValuesDetailsModel | |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| nodeId optional |
Node to read from (mandatory without browse path) | string |
| timestampsToReturn optional |
TimestampsToReturn |
ReadValuesDetailsModelHistoryReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ReadValuesDetailsModelHistoryReadRequestModel |
RequestHeaderModel
Request header model
| Name | Description | Schema |
|---|---|---|
| connectTimeout optional |
Connect timeout in ms. As opposed to the service call timeout this terminates the entire transaction if it takes longer than the timeout to connect a session A connect and reconnect during the service call resets the timeout therefore the overall time for the call to complete can be longer than specified. |
integer (int32) |
| diagnostics optional |
DiagnosticsModel | |
| elevation optional |
CredentialModel | |
| locales optional |
Optional list of preferred locales in preference order to be used during connecting the session. We suggest to use the connection object to set the locales |
< string > array |
| namespaceFormat optional |
NamespaceFormat | |
| operationTimeout optional |
Operation timeout in ms. This applies to every operation that is invoked, not to the entire transaction and overrides the configured operation timeout. |
integer (int32) |
| serviceCallTimeout optional |
Service call timeout in ms. As opposed to the operation timeout this terminates the entire transaction if it takes longer than the timeout to complete. Note that a connect and reconnect during the service call is gated by the connect timeout setting. If a connect timeout is not specified this timeout is used also for connect timeout. |
integer (int32) |
RequestHeaderModelPublishedNodesEntryRequestModel
Wraps a request and a published nodes entry to bind to a body more easily for api that requires an entry and additional configuration
| Name | Schema |
|---|---|
| entry required |
PublishedNodesEntryModel |
| request optional |
RequestHeaderModel |
RequestHeaderModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
RequestHeaderModel |
RolePermissionModel
Role permission model
| Name | Description | Schema |
|---|---|---|
| permissions optional |
RolePermissions | |
| roleId required |
Identifier of the role object. Minimum length : 1 |
string |
RolePermissions
Individual permissions assigned to a role
Type : enum (None, Browse, ReadRolePermissions, WriteAttribute, WriteRolePermissions, WriteHistorizing, Read, Write, ReadHistory, InsertHistory, ModifyHistory, DeleteHistory, ReceiveEvents, Call, AddReference, RemoveReference, DeleteNode, AddNode)
SecurityMode
Specifies the security mode for OPC UA endpoint connections. Determines how messages are protected during transmission between the Publisher and OPC UA servers. Proper security mode selection is crucial for protecting sensitive data and credentials.
Type : enum (Best, Sign, SignAndEncrypt, None, NotNone)
ServerCapabilitiesModel
Server capabilities
| Name | Description | Schema |
|---|---|---|
| MaxMonitoredItems optional |
Supported aggregate functions | integer (int64) |
| MaxMonitoredItemsPerSubscription optional |
Supported aggregate functions | integer (int64) |
| MaxMonitoredItemsQueueSize optional |
Supported aggregate functions | integer (int64) |
| MaxSelectClauseParameters optional |
Supported aggregate functions | integer (int64) |
| MaxSessions optional |
Supported aggregate functions | integer (int64) |
| MaxSubscriptions optional |
Supported aggregate functions | integer (int64) |
| MaxSubscriptionsPerSession optional |
Supported aggregate functions | integer (int64) |
| MaxWhereClauseParameters optional |
Supported aggregate functions | integer (int64) |
| aggregateFunctions optional |
Supported aggregate functions | < string, string > map |
| conformanceUnits optional |
Supported aggregate functions | < string > array |
| modellingRules optional |
Supported modelling rules | < string, string > map |
| operationLimits required |
OperationLimitsModel | |
| serverProfileArray optional |
Server profiles | < string > array |
| supportedLocales optional |
Supported locales | < string > array |
ServerEndpointQueryModel
Endpoint model
| Name | Description | Schema |
|---|---|---|
| certificate optional |
Endpoint must match with this certificate thumbprint | string |
| discoveryUrl optional |
Discovery url to use to query | string |
| securityMode optional |
SecurityMode | |
| securityPolicy optional |
Endpoint must support this Security policy. | string |
| url optional |
Endpoint url that should match the found endpoint | string |
ServerRegistrationRequestModel
Server registration request
| Name | Description | Schema |
|---|---|---|
| context optional |
OperationContextModel | |
| discoveryUrl required |
Discovery url to use for registration Minimum length : 1 |
string |
| id optional |
User defined request id | string |
ServiceResultModel
Service result
| Name | Description | Schema |
|---|---|---|
| additionalInfo optional |
Additional information if available | string |
| errorMessage optional |
Error message in case of error or null. | string |
| inner optional |
ServiceResultModel | |
| locale optional |
Locale of the error message | string |
| namespaceUri optional |
Namespace uri | string |
| statusCode optional |
Error code - if null operation succeeded. | integer (int64) |
| symbolicId optional |
Symbolic identifier | string |
SetConfiguredEndpointsRequestModel
Set configured endpoints request call
| Name | Description | Schema |
|---|---|---|
| endpoints optional |
Endpoints and nodes that make up the configuration | < PublishedNodesEntryModel > array |
SimpleAttributeOperandModel
Simple attribute operand model
| Name | Description | Schema |
|---|---|---|
| attributeId optional |
NodeAttribute | |
| browsePath optional |
Browse path of attribute operand | < string > array |
| dataSetClassFieldId optional |
Optional data set class field id (Publisher extension) | string (uuid) |
| displayName optional |
Optional display name | string |
| indexRange optional |
Index range of attribute operand | string |
| typeDefinitionId optional |
Type definition node id if operand is simple or full attribute operand. |
string |
SubscriptionWatchdogBehavior
Defines how the publisher responds when monitored items stop reporting data. The watchdog triggers when items are late according to OpcNodeWatchdogTimespan and OpcNodeWatchdogCondition settings. Can be configured globally via the –dwb command line option.
Type : enum (Diagnostic, Reset, FailFast, ExitProcess)
TestConnectionRequestModel
Test connection request
| Name | Schema |
|---|---|
| header optional |
RequestHeaderModel |
TestConnectionRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
TestConnectionRequestModel |
TestConnectionResponseModel
Test connection response
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
TimestampsToReturn
Timestamps
Type : enum (Both, Source, Server, None)
TypeDefinitionModel
Type definition
| Name | Description | Schema |
|---|---|---|
| browseName optional |
Browse name | string |
| description optional |
Description if any | string |
| displayName optional |
Display name | string |
| nodeType optional |
NodeType | |
| typeDefinitionId required |
The node id of the type of the node Minimum length : 1 |
string |
| typeHierarchy optional |
Super types hierarchy starting from base type up to Azure.IIoT.OpcUa.Publisher.Models.TypeDefinitionModel.TypeDefinitionId which is not included. |
< NodeModel > array |
| typeMembers optional |
Fully inherited instance declarations of the type of the node. |
< InstanceDeclarationModel > array |
UpdateEventsDetailsModel
Insert, upsert or replace historic events
| Name | Description | Schema |
|---|---|---|
| events required |
The new events to insert | < HistoricEventModel > array |
| filter optional |
EventFilterModel |
UpdateEventsDetailsModelHistoryUpdateRequestModel
Request node history update
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
UpdateEventsDetailsModel | |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to update (mandatory without browse path) | string |
UpdateEventsDetailsModelHistoryUpdateRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
UpdateEventsDetailsModelHistoryUpdateRequestModel |
UpdateValuesDetailsModel
Insert, upsert, or update historic values
| Name | Description | Schema |
|---|---|---|
| values required |
Values to insert | < HistoricValueModel > array |
UpdateValuesDetailsModelHistoryUpdateRequestModel
Request node history update
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
UpdateValuesDetailsModel | |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to update (mandatory without browse path) | string |
UpdateValuesDetailsModelHistoryUpdateRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
UpdateValuesDetailsModelHistoryUpdateRequestModel |
UserIdentityModel
User identity model
| Name | Description | Schema |
|---|---|---|
| password optional |
For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.UserName authentication this is the password of the user. For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.X509Certificate authentication this is the passcode to export the configured certificate’s private key. Not used for the other authentication types. |
string |
| thumbprint optional |
For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.X509Certificate authentication this is the thumbprint of the configured certificate to use. Either Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.User or Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.Thumbprint must be used to select the certificate in the user certificate store. Not used for the other authentication types. |
string |
| user optional |
For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.UserName authentication this is the name of the user. For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.X509Certificate authentication this is the subject name of the certificate that has been configured. Either Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.User or Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.Thumbprint must be used to select the certificate in the user certificate store. Not used for the other authentication types. |
string |
ValueReadRequestModel
Request node value read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to an actual node. |
< string > array |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| maxAge optional |
Maximum age of the value to be read in milliseconds. The age of the value is based on the difference between the ServerTimestamp and the time when the Server starts processing the request. If not supplied, the Server shall attempt to read a new value from the data source. |
string (date-span) |
| nodeId optional |
Node to read from (mandatory) | string |
| timestampsToReturn optional |
TimestampsToReturn |
ValueReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ValueReadRequestModel |
ValueReadResponseModel
Value read response model
| Name | Description | Schema |
|---|---|---|
| dataType optional |
Built in data type of the value read. | string |
| errorInfo optional |
ServiceResultModel | |
| serverPicoseconds optional |
Pico seconds part of when value was read at server. | integer (int32) |
| serverTimestamp optional |
Timestamp of when value was read at server. | string (date-time) |
| sourcePicoseconds optional |
Pico seconds part of when value was read at source. | integer (int32) |
| sourceTimestamp optional |
Timestamp of when value was read at source. | string (date-time) |
| value optional |
Value read | object |
ValueWriteRequestModel
Value write request model
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| dataType optional |
A built in datatype for the value. This can be a data type from browse, or a built in type. (default: best effort) |
string |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to write | string |
| nodeId optional |
Node id to write value to. | string |
| value required |
Value to write. The system tries to convert the value according to the data type value, e.g. convert comma seperated value strings into arrays. (Mandatory) |
object |
ValueWriteRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
ValueWriteRequestModel |
ValueWriteResponseModel
Value write response model
| Name | Schema |
|---|---|
| errorInfo optional |
ServiceResultModel |
VariableMetadataModel
Variable metadata model
| Name | Description | Schema |
|---|---|---|
| arrayDimensions optional |
Array dimensions of the variable. | integer (int64) |
| dataType optional |
DataTypeMetadataModel | |
| valueRank optional |
NodeValueRank |
VariantValueHistoryReadNextResponseModel
History read continuation result
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| history required |
History as json encoded extension object | object |
VariantValueHistoryReadRequestModel
Request node history read
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
The HistoryReadDetailsType extension object encoded in json and containing the tunneled Historian reader request. |
object |
| header optional |
RequestHeaderModel | |
| indexRange optional |
Index range to read, e.g. 1:2,0:1 for 2 slices out of a matrix or 0:1 for the first item in an array, string or bytestring. See 7.22 of part 4: NumericRange. |
string |
| nodeId optional |
Node to read from (mandatory without browse path) | string |
| timestampsToReturn optional |
TimestampsToReturn |
VariantValueHistoryReadRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
VariantValueHistoryReadRequestModel |
VariantValueHistoryReadResponseModel
History read results
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation token if more results pending. | string |
| errorInfo optional |
ServiceResultModel | |
| history required |
History as json encoded extension object | object |
VariantValueHistoryUpdateRequestModel
Request node history update
| Name | Description | Schema |
|---|---|---|
| browsePath optional |
An optional path from NodeId instance to the actual node. |
< string > array |
| details required |
The HistoryUpdateDetailsType extension object encoded as json Variant and containing the tunneled update request for the Historian server. The value is updated at edge using above node address. |
object |
| header optional |
RequestHeaderModel | |
| nodeId optional |
Node to update (mandatory without browse path) | string |
VariantValueHistoryUpdateRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
VariantValueHistoryUpdateRequestModel |
VariantValuePublishedNodeCreateAssetRequestModel
Request to create an asset in the configuration api
| Name | Description | Schema |
|---|---|---|
| configuration required |
The asset configuration to use when creating the asset. | object |
| entry required |
PublishedNodesEntryModel | |
| header optional |
RequestHeaderModel | |
| waitTime optional |
Time to wait after the configuration is applied to perform the configuration of the asset in the configuration api. This is to let the server settle. |
string (date-span) |
WriteRequestModel
Request node attribute write
| Name | Description | Schema |
|---|---|---|
| attributes required |
Attributes to update | < AttributeWriteRequestModel > array |
| header optional |
RequestHeaderModel |
WriteRequestModelRequestEnvelope
Wraps a request and a connection to bind to a body more easily for api that requires a connection endpoint
| Name | Schema |
|---|---|
| connection required |
ConnectionModel |
| request optional |
WriteRequestModel |
WriteResponseModel
Result of attribute write
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| results required |
All results of attribute writes | < AttributeWriteResponseModel > array |
WriterGroupTransport
Specifies the transport technology used to publish messages from OPC Publisher. Each transport offers different capabilities for message delivery, routing, and quality of service. The transport choice affects how messages are delivered and what features are available.
Type : enum (IoTHub, Mqtt, EventHub, Dapr, Http, FileSystem, AioMqtt, AioDss, Null)
X509CertificateChainModel
Certificate chain
| Name | Description | Schema |
|---|---|---|
| chain optional |
Chain | < X509CertificateModel > array |
| status optional |
Chain validation status if validated | enum (NotTimeValid, Revoked, NotSignatureValid, NotValidForUsage, UntrustedRoot, RevocationStatusUnknown, Cyclic, InvalidExtension, InvalidPolicyConstraints, InvalidBasicConstraints, InvalidNameConstraints, HasNotSupportedNameConstraint, HasNotDefinedNameConstraint, HasNotPermittedNameConstraint, HasExcludedNameConstraint, PartialChain, CtlNotTimeValid, CtlNotSignatureValid, CtlNotValidForUsage, HasWeakSignature, OfflineRevocation, NoIssuanceChainPolicy, ExplicitDistrust, HasNotSupportedCriticalExtension) |
X509CertificateModel
Certificate model
| Name | Description | Schema |
|---|---|---|
| hasPrivateKey optional |
Contains private key | boolean |
| notAfterUtc optional |
Not after validity | string (date-time) |
| notBeforeUtc optional |
Not before validity | string (date-time) |
| pfx optional |
Certificate as Pkcs12 | < integer (int32) > array |
| selfSigned optional |
Self signed certificate | boolean |
| serialNumber optional |
Serial number | string |
| subject optional |
Subject | string |
| thumbprint optional |
Thumbprint | string |
X509ChainStatus
Status of x509 chain
Type : enum (NotTimeValid, Revoked, NotSignatureValid, NotValidForUsage, UntrustedRoot, RevocationStatusUnknown, Cyclic, InvalidExtension, InvalidPolicyConstraints, InvalidBasicConstraints, InvalidNameConstraints, HasNotSupportedNameConstraint, HasNotDefinedNameConstraint, HasNotPermittedNameConstraint, HasExcludedNameConstraint, PartialChain, CtlNotTimeValid, CtlNotSignatureValid, CtlNotValidForUsage, HasWeakSignature, OfflineRevocation, NoIssuanceChainPolicy, ExplicitDistrust, HasNotSupportedCriticalExtension)