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 |
ApplicationInfoListModel
List of registered applications
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items required |
Application infos | < ApplicationInfoModel > array |
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 |
ApplicationRegistrationQueryModel
Application information
| Name | Description | Schema |
|---|---|---|
| applicationName optional |
Name of application | string |
| applicationType optional |
ApplicationType | |
| applicationUri optional |
Application uri | string |
| capability optional |
Application capability to query with | string |
| discovererId optional |
Discoverer id to filter with | string |
| discoveryProfileUri optional |
Discovery profile uri | string |
| gatewayServerUri optional |
Gateway server uri | string |
| includeNotSeenSince optional |
Whether to include apps that were soft deleted | boolean |
| locale optional |
Locale of application name - default is “en” | string |
| productUri optional |
Product uri | string |
| siteOrGatewayId optional |
Supervisor or site the application belongs to. | string |
ApplicationRegistrationRequestModel
Application information
| Name | Description | Schema |
|---|---|---|
| applicationName optional |
Default name of the server or client. | string |
| applicationType optional |
ApplicationType | |
| applicationUri required |
Unique application uri Minimum length : 1 |
string |
| capabilities optional |
The OPC UA defined capabilities of the server. | < string > array |
| context optional |
OperationContextModel | |
| discoveryProfileUri optional |
The discovery profile uri of the server. | string |
| discoveryUrls optional |
Discovery urls of the server. | < string > array |
| gatewayServerUri optional |
Gateway server uri | string |
| locale optional |
Locale of default name | string |
| localizedNames optional |
Localized names key off locale id. | < string, string > map |
| productUri optional |
Product uri of the application. Example : "http://contoso.com/fridge/1.0" |
string |
| siteId optional |
Site of the application | string |
ApplicationRegistrationResponseModel
Result of an application registration
| Name | Description | Schema |
|---|---|---|
| id required |
New id application was registered under | string |
ApplicationRegistrationUpdateModel
Application registration update request
| Name | Description | Schema |
|---|---|---|
| applicationName optional |
Default name of the server or client. | string |
| capabilities optional |
Capabilities of the application | < string > array |
| context optional |
OperationContextModel | |
| discoveryProfileUri optional |
Discovery profile uri | string |
| discoveryUrls optional |
Discovery urls of the application | < string > array |
| gatewayServerUri optional |
Gateway server uri | string |
| locale optional |
Locale of default name - defaults to “en” | string |
| localizedNames optional |
Localized names keyed off locale id. To remove entry, set value for locale id to null. |
< string, string > map |
| productUri optional |
Product uri | string |
ApplicationSiteListModel
List of application sites
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| sites optional |
Sites | < string > 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 |
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 |
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 |
BrowsePathResponseModel
Result of node browse continuation
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| targets optional |
Targets | < NodePathTargetModel > array |
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 |
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) |
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
Data set routing
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 |
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 |
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 |
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) |
DiscovererListModel
Discoverer registration list
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items optional |
Registrations | < DiscovererModel > array |
DiscovererModel
Discoverer registration
| Name | Description | Schema |
|---|---|---|
| apiKey optional |
Current api key | string |
| connected optional |
Whether discoverer is connected on this registration | boolean |
| discovery optional |
DiscoveryMode | |
| discoveryConfig optional |
DiscoveryConfigModel | |
| id required |
Discoverer id Minimum length : 1 |
string |
| outOfSync optional |
Whether the registration is out of sync between client (module) and server (service) (default: false). |
boolean |
| requestedConfig optional |
DiscoveryConfigModel | |
| requestedMode optional |
DiscoveryMode | |
| siteId optional |
Site of the discoverer | string |
| version optional |
The reported version of the discovery module | string |
DiscovererQueryModel
Discoverer registration query
| Name | Description | Schema |
|---|---|---|
| connected optional |
Included connected or disconnected | boolean |
| discovery optional |
DiscoveryMode | |
| siteId optional |
Site of the discoverer | string |
DiscovererUpdateModel
Discoverer update request
| Name | Description | Schema |
|---|---|---|
| siteId optional |
Site the discoverer is part of | 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 |
EndpointConnectivityState
State of the endpoint after activation
Type : enum (Connecting, NotReachable, Busy, NoTrust, CertificateInvalid, Ready, Error, Disconnected, Unauthorized)
EndpointInfoListModel
Endpoint info list
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items required |
Endpoint infos | < EndpointInfoModel > array |
EndpointInfoModel
Endpoint info
| Name | Description | Schema |
|---|---|---|
| applicationId required |
Application id endpoint is registered under. Minimum length : 1 |
string |
| endpointState optional |
EndpointConnectivityState | |
| notSeenSince optional |
Last time endpoint was seen | string (date-time) |
| registration required |
EndpointRegistrationModel |
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 |
EndpointRegistrationQueryModel
Endpoint query
| Name | Description | Schema |
|---|---|---|
| applicationId optional |
Application id to filter | string |
| certificate optional |
Certificate thumbprint of the endpoint | string |
| discovererId optional |
Discoverer id to filter with | string |
| endpointState optional |
EndpointConnectivityState | |
| includeNotSeenSince optional |
Whether to include endpoints that were soft deleted | boolean |
| securityMode optional |
SecurityMode | |
| securityPolicy optional |
Endpoint security policy to use - null = Best. | string |
| siteOrGatewayId optional |
Site or gateway id to filter with | string |
| url optional |
Endoint url for direct server access | 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)
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)
GatewayInfoModel
Gateway info model
| Name | Schema |
|---|---|
| gateway required |
GatewayModel |
| modules optional |
GatewayModulesModel |
GatewayListModel
Gateway registration list
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items optional |
Registrations | < GatewayModel > array |
GatewayModel
Gateway registration model
| Name | Description | Schema |
|---|---|---|
| connected optional |
Whether gateway is connected | boolean |
| id required |
Gateway id Minimum length : 1 |
string |
| siteId optional |
Site of the Gateway | string |
GatewayModulesModel
Gateway modules
| Name | Schema |
|---|---|
| discoverer optional |
DiscovererModel |
| publisher optional |
PublisherModel |
| supervisor optional |
SupervisorModel |
GatewayQueryModel
Gateway registration query
| Name | Description | Schema |
|---|---|---|
| connected optional |
Included connected or disconnected | boolean |
| siteId optional |
Site of the Gateway | string |
GatewayUpdateModel
Gateway registration update request
| Name | Description | Schema |
|---|---|---|
| siteId optional |
Site of the Gateway | string |
HeartbeatBehavior
Heartbeat behavior
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 |
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 |
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 |
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 |
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
Message encoding
Type : enum (Uadp, Json, Xml, Avro, IsReversible, JsonReversible, IsGzipCompressed, JsonGzip, AvroGzip, JsonReversibleGzip)
MessagingMode
Message modes
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 |
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 |
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
Monitored item watchdog condition
Type : enum (WhenAllAreLate, WhenAnyIsLate)
NamespaceFormat
Namespace serialization format for node ids and qualified names.
Type : enum (Uri, Index, Expanded)
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
Node id serialized as object
| Name | Description | Schema |
|---|---|---|
| Identifier optional |
Identifier | 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 |
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
Enum that defines the authentication method
Type : enum (Anonymous, UsernamePassword, Certificate)
OpcNodeModel
Describing an entry in the node list
| Name | Description | Schema |
|---|---|---|
| AttributeId optional |
NodeAttribute | |
| BrowsePath optional |
Browse path from the node to reach the actual node to monitor. |
< string > array |
| ConditionHandling optional |
ConditionHandlingOptionsModel | |
| CyclicReadMaxAgeTimespan optional |
The max cache age to use for cyclic reads. Default is 0 (uncached reads). |
string (date-span) |
| DataChangeTrigger optional |
DataChangeTriggerType | |
| DataSetClassFieldId optional |
The identifier of the field in the dataset class. Allows correlation to the data set class. |
string (uuid) |
| DataSetFieldId optional |
The identifier of the field in the dataset message. If not provided Azure.IIoT.OpcUa.Publisher.Models.OpcNodeModel.DisplayName is used. |
string |
| DeadbandType optional |
DeadbandType | |
| DeadbandValue optional |
Deadband value of the data change filter to apply. Does not apply to events |
number (double) |
| DiscardNew optional |
Discard new values in the server queue instead of old values when no more room in queue. |
boolean |
| DisplayName optional |
Display name | string |
| EventFilter optional |
EventFilterModel | |
| ExpandedNodeId optional |
Expanded Node identifier (same as Azure.IIoT.OpcUa.Publisher.Models.OpcNodeModel.Id) | string |
| FetchDisplayName optional |
Fetch display name from the node | boolean |
| HeartbeatBehavior optional |
HeartbeatBehavior | |
| HeartbeatInterval optional |
Heartbeat interval in seconds | integer (int32) |
| HeartbeatIntervalTimespan optional |
Heartbeat interval as TimeSpan. | string (date-span) |
| Id optional |
Node Identifier | string |
| IndexRange optional |
Index range to read, default to null. | string |
| ModelChangeHandling optional |
ModelChangeHandlingOptionsModel | |
| OpcPublishingInterval optional |
Publishing interval in milliseconds | integer (int32) |
| OpcPublishingIntervalTimespan optional |
OpcPublishingInterval as TimeSpan. | string (date-span) |
| OpcSamplingInterval optional |
Sampling interval in milliseconds | integer (int32) |
| OpcSamplingIntervalTimespan optional |
OpcSamplingInterval as TimeSpan. | string (date-span) |
| QualityOfService optional |
QoS | |
| QueueSize optional |
Queue Size for the monitored item on the server. Specifies how many values are queued on the server before undelivered ones are discarded. |
integer (int64) |
| RegisterNode optional |
Register node for reading before sampling. | boolean |
| SkipFirst optional |
Do not send the first value that is always provided by the server when the monitored item is created. |
boolean |
| Topic optional |
Topic to publish to - splits network messages along the lines of topic name and overrides the queue name of the writer and writer group. |
string |
| TriggeredNodes optional |
Nodes that are triggered by the parent node. Nodes cannot themselves trigger other nodes, any such setting is silently discarded. Triggered nodes can only be updated as an atomic unit using API. |
< OpcNodeModel > array |
| UseCyclicRead optional |
Use cyclic read to sample. | 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 |
| Extensions optional |
object |
| 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 |
PublishBulkResponseModel
Result of bulk request
| Name | Description | Schema |
|---|---|---|
| nodesToAdd optional |
Node to add | < ServiceResultModel > array |
| nodesToRemove optional |
Node to remove | < ServiceResultModel > array |
PublishStartRequestModel
Publish request
| Name | Schema |
|---|---|
| header optional |
RequestHeaderModel |
| item required |
PublishedItemModel |
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 |
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 |
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) |
PublishedNodesEntryModel
Contains the nodes which should be published
| Name | Description | Schema |
|---|---|---|
| BatchSize optional |
Send network messages when the notification queue exceeds this number. Causes this many notifications to be added to network messages |
integer (int64) |
| BatchTriggerInterval optional |
Send network messages at the specified publishing interval. |
integer (int32) |
| BatchTriggerIntervalTimespan optional |
Send network messages at the specified publishing interval. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.BatchTriggerInterval if defined. |
string (date-span) |
| DataSetClassId optional |
A dataset class id. | string (uuid) |
| DataSetDescription optional |
The optional description of the dataset. | string |
| DataSetExtensionFields optional |
Optional field and value pairs to insert into the data sets emitted by data set writer. |
< string, object > map |
| DataSetFetchDisplayNames optional |
Whether to fetch the display name and use it as data set id for all opc node items in the data set |
boolean |
| DataSetKeyFrameCount optional |
Insert a key frame every x messages | integer (int64) |
| DataSetName optional |
The optional short name of the dataset. | string |
| DataSetPublishingInterval optional |
The Publishing interval for a dataset writer in miliseconds. |
integer (int32) |
| DataSetPublishingIntervalTimespan optional |
The Publishing interval for a dataset writer in timespan format. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.DataSetPublishingInterval if defined. |
string (date-span) |
| DataSetRouting optional |
DataSetRoutingMode | |
| DataSetSamplingInterval optional |
The default sampling interval for all items in a dataset writer in miliseconds if the nodes do not specify a sampling rate. |
integer (int32) |
| DataSetSamplingIntervalTimespan optional |
The Sampling interval for the nodes in the dataset writer in timespan format. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.DataSetSamplingInterval if defined. |
string (date-span) |
| DataSetWriterGroup optional |
The Group the writer belongs to. | string |
| DataSetWriterId optional |
Name of the data set writer. | string |
| DataSetWriterWatchdogBehavior optional |
SubscriptionWatchdogBehavior | |
| DefaultHeartbeatBehavior optional |
HeartbeatBehavior | |
| DefaultHeartbeatInterval optional |
Default heartbeat interval in milliseconds | integer (int32) |
| DefaultHeartbeatIntervalTimespan optional |
Default heartbeat interval for all nodes as duration. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.DefaultHeartbeatInterval if defined. |
string (date-span) |
| DisableSubscriptionTransfer optional |
Disable subscription transfer on reconnect | boolean |
| DumpConnectionDiagnostics optional |
Dump server diagnostics for the connection to enable advanced troubleshooting scenarios. |
boolean |
| EncryptedAuthPassword optional |
encrypted password | string |
| EncryptedAuthUsername optional |
encrypted username | string |
| EndpointSecurityMode optional |
SecurityMode | |
| EndpointSecurityPolicy optional |
The specific security policy to use for the specified endpoint. Overrides Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.UseSecurity setting. If the security policy is not available with the specified security mode connectivity will fail. |
string |
| EndpointUrl required |
The endpoint URL of the OPC UA server. Minimum length : 1 |
string |
| LastChangeDateTime optional |
Last change to the entry | string (date-time) |
| MaxKeepAliveCount optional |
When the publishing timer has expired this number of times without requiring any Notification to be sent, to the writer a keep-alive message is sent. |
integer (int64) |
| MessageEncoding optional |
MessageEncoding | |
| MessageRetention optional |
Message retention setting for messages sent by the writer if the transport supports it. |
boolean |
| MessageTtlTimespan optional |
Message time to live for messages sent by the writer if the transport supports it. |
string (date-span) |
| MessagingMode optional |
MessagingMode | |
| MetaDataQueueName optional |
Meta data queue name to use for the writer. Overrides the default metadata topic template. |
string |
| MetaDataUpdateTime optional |
Send metadata at the configured interval even when not changing expressed in milliseconds. |
integer (int32) |
| MetaDataUpdateTimeTimespan optional |
Send metadata at the configured interval even when not changing expressed as duration. Takes precedence over Azure.IIoT.OpcUa.Publisher.Models.PublishedNodesEntryModel.MetaDataUpdateTimeif defined. |
string (date-span) |
| NodeId optional |
NodeIdModel | |
| OpcAuthenticationMode optional |
OpcAuthenticationMode | |
| OpcAuthenticationPassword optional |
plain password | string |
| OpcAuthenticationUsername optional |
plain username | string |
| OpcNodeWatchdogCondition optional |
MonitoredItemWatchdogCondition | |
| OpcNodeWatchdogTimespan optional |
The timeout to use to monitor the monitored items in the subscription are continously reporting fresh data. |
string (date-span) |
| OpcNodes optional |
Nodes defined in the collection. | < OpcNodeModel > array |
| Priority optional |
Priority of the writer subscription. | integer (int32) |
| QualityOfService optional |
QoS | |
| QueueName optional |
Writer queue overrides the writer group queue name. Network messages are then split across queues with Qos also accounted for. |
string |
| RepublishAfterTransfer optional |
Republish after transferring the subscription during reconnect handling unless subscription transfer was disabled. |
boolean |
| SendKeepAliveDataSetMessages optional |
Send a keep alive message when a subscription keep alive notification is received inside the writer. If keep alive messages are not supported by the messaging profile chosen this value is ignored. |
boolean |
| UseReverseConnect optional |
Use reverse connect to connect ot the endpoint | boolean |
| UseSecurity optional |
Secure transport should be used to connect to the opc server. |
boolean |
| Version optional |
Version number of the entry | integer (int64) |
| WriterGroupMessageRetention optional |
Default message retention setting for messages sent through the writer group if the transport supports it. |
boolean |
| WriterGroupMessageTtlTimepan optional |
Default time to live for messages sent through the writer group if the transport supports it. |
string (date-span) |
| WriterGroupPartitions optional |
Number of partitions to split the writer group into when publishing to target topics. |
integer (int32) |
| WriterGroupQualityOfService optional |
QoS | |
| WriterGroupQueueName optional |
Writer group queue overrides the default writer group topic template to use. |
string |
| WriterGroupTransport optional |
WriterGroupTransport |
PublishedNodesEntryModelIAsyncEnumerable
Type : object
PublisherListModel
Publisher list
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items optional |
Registrations | < PublisherModel > array |
PublisherModel
Publisher registration
| Name | Description | Schema |
|---|---|---|
| apiKey optional |
Current api key | string |
| connected optional |
Whether publisher is connected | boolean |
| id required |
Identifier of the publisher Minimum length : 1 |
string |
| outOfSync optional |
Whether the registration is out of sync between client (module) and server (service) (default: false). |
boolean |
| siteId optional |
Site of the publisher | string |
| version optional |
The reported version of the publisher | string |
PublisherQueryModel
Publisher registration query request
| Name | Description | Schema |
|---|---|---|
| connected optional |
Included connected or disconnected | boolean |
| siteId optional |
Site for the supervisors | string |
PublisherUpdateModel
Publisher registration update request
| Name | Description | Schema |
|---|---|---|
| apiKey optional |
New api key | string |
| siteId optional |
Site of the publisher | string |
QoS
Type : enum (AtMostOnce, AtLeastOnce, ExactlyOnce)
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 |
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 |
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 |
ReadRequestModel
Request node attribute read
| Name | Description | Schema |
|---|---|---|
| attributes required |
Attributes to read | < AttributeReadRequestModel > array |
| header optional |
RequestHeaderModel |
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 |
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 |
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) |
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
Security mode of endpoint
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
Subscription watchdog behavior
Type : enum (Diagnostic, Reset, FailFast, ExitProcess)
SupervisorListModel
Supervisor list
| Name | Description | Schema |
|---|---|---|
| continuationToken optional |
Continuation or null if final | string |
| items optional |
Registrations | < SupervisorModel > array |
SupervisorModel
Supervisor registration
| Name | Description | Schema |
|---|---|---|
| apiKey optional |
Api key of the module | string |
| connected optional |
Whether supervisor is connected | boolean |
| id required |
Identifier of the supervisor Minimum length : 1 |
string |
| outOfSync optional |
Whether the registration is out of sync between client (module) and server (service) (default: false). |
boolean |
| siteId optional |
Site of the supervisor | string |
| version optional |
The reported version of the supervisor | string |
SupervisorQueryModel
Supervisor registration query
| Name | Description | Schema |
|---|---|---|
| connected optional |
Included connected or disconnected | boolean |
| endpointId optional |
Managing provided endpoint twin | string |
| siteId optional |
Site for the supervisors | string |
SupervisorUpdateModel
Supervisor update request
| Name | Description | Schema |
|---|---|---|
| siteId optional |
Site the supervisor is part of | string |
TestConnectionRequestModel
Test connection request
| Name | Schema |
|---|---|
| header optional |
RequestHeaderModel |
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 |
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 |
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 |
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 |
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 |
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 |
WriteRequestModel
Request node attribute write
| Name | Description | Schema |
|---|---|---|
| attributes required |
Attributes to update | < AttributeWriteRequestModel > array |
| header optional |
RequestHeaderModel |
WriteResponseModel
Result of attribute write
| Name | Description | Schema |
|---|---|---|
| errorInfo optional |
ServiceResultModel | |
| results required |
All results of attribute writes | < AttributeWriteResponseModel > array |
WriterGroupTransport
Desired writer group transport
Type : enum (IoTHub, Mqtt, EventHub, Dapr, Http, FileSystem, 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)