Sign in
Writer

AddOrUpdateNode

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

put/v2/writer/{dataSetWriterGroup}/{dataSetWriterId}

Path parameters

dataSetWriterGroupstring required

The writer group name of the entry

dataSetWriterIdstring required

The data set writer identifer of the entry

Query parameters

insertAfterFieldIdstring

Field after which to insert the nodes. If not specified, nodes are added at the end of the entry

Request body

Idstring

Node Identifier

OpcSamplingIntervalinteger

Sampling interval in milliseconds

OpcSamplingIntervalTimespanstring date-span

OpcSamplingInterval as TimeSpan.

DataSetFieldIdstring

The identifier of the field in the dataset message. If not provided Azure.IIoT.OpcUa.Publisher.Models.OpcNodeModel.DisplayName is used.

DataSetClassFieldIdstring uuid

The identifier of the field in the dataset class. Allows correlation to the data set class.

DisplayNamestring

Display name

QueueSizeinteger

Queue Size for the monitored item on the server. Specifies how many values are queued on the server before undelivered ones are discarded.

DiscardNewboolean

Discard new values in the server queue instead of old values when no more room in queue.

DataChangeTrigger'Status' | 'StatusValue' | 'StatusValueTimestamp'

Data change trigger

DeadbandType'Absolute' | 'Percent'

Deadband type

DeadbandValuenumber double

Deadband value of the data change filter to apply. Does not apply to events

BrowsePathstring[]

Browse path from the node to reach the actual node to monitor.

AttributeId'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'

Node attribute identifiers

IndexRangestring

Index range to read, default to null.

Topicstring

Topic to publish to - splits network messages along the lines of topic name and overrides the queue name of the writer and writer group.

QualityOfService'AtMostOnce' | 'AtLeastOnce' | 'ExactlyOnce'
HeartbeatBehavior'WatchdogLKV' | 'WatchdogLKG' | 'PeriodicLKV' | 'PeriodicLKG' | 'WatchdogLKVWithUpdatedTimestamps' | 'WatchdogLKVDiagnosticsOnly'

Heartbeat behavior

HeartbeatIntervalinteger

Heartbeat interval in seconds

HeartbeatIntervalTimespanstring date-span

Heartbeat interval as TimeSpan.

SkipFirstboolean

Do not send the first value that is always provided by the server when the monitored item is created.

OpcPublishingIntervalinteger

Publishing interval in milliseconds

OpcPublishingIntervalTimespanstring date-span

OpcPublishingInterval as TimeSpan.

UseCyclicReadboolean

Use cyclic read to sample.

RegisterNodeboolean

Register node for reading before sampling.

FetchDisplayNameboolean

Fetch display name from the node

ExpandedNodeIdstring

Expanded Node identifier (same as Azure.IIoT.OpcUa.Publisher.Models.OpcNodeModel.Id)

Response

The item was added

Changes