Write
-
Writes item and property values.
-
Required security permission - WRITE.
-
HTTP methods supported: POST.
Description
Write can be performed to set the object value or object property for one or more items.
Parameters
Name | Type | Optional | Description |
---|---|---|---|
write_fetch |
string |
yes |
Defines how to read the value before writing. The possible values are: "OPC_READ_CACHE_BEFORE_WRITE" (the default value) "OPC_READ_DEVICE_BEFORE_WRITE" "OPC_READ_OBJECT_BEFORE_WRITE" "OPC_NO_READ_BEFORE_WRITE". |
write_delay |
integer |
yes |
Time to wait in order to collect multiple writes. |
write_audit |
boolean |
yes |
Create audit in system log for write operation, by default false. |
write_timeo |
integer |
yes |
Write timeout. Currently has no effect. |
write_group |
boolean |
yes |
Force OPC DA 2.05. Defines which OPC write method should be used. False(the default value) : OPC write uses the DA 3.0 write method(IOPCSyncIO2::WriteVQT). This allows to write value, quality and timestamp. True: OPC writes uses the DA 2.05 write method(IOPCSyncIO::Write). This allows to write value only. Some OPC Server do not support the DA 3.0 write method. |
fields |
string |
yes |
Comma separated string to customize which fields should be included in the response, by default 'i,p,v,q,t'. Provide 'ALL' to include all fields. |
roe |
boolean |
yes |
ReturnOnlyErrors, indicates the response should only contain item values for which the write operation failed, by default false. |
insights |
boolean |
yes |
Indicates application insights should be included in the response, by default false. |
Examples
Write actual value
This example shows response of a write actual value request of a single or multiple objects or object properties.
Object properties like name, description, engineering unit, etc. have a unique path, an example of the object property Object Name
is System/Core/Examples/Demo Data/Process Data/DC4711.ObjectName
. Property path can be used the same way as a regular object path to read, write, create, modify, update or delete the property value.
Modify object properties
This example shows how to modify object name.