Insert multiple tag values

Add the specified tag values with their timestamps.

Last Update: 7 NOV 2024

Example URL

https://{api_base_url}/integration/webapi/tag/value?mode=write

Note: This endpoint demonstrates querying the value for a specific tag with the mode=write query parameter. In this example, the query specifies that the data should be in write mode, indicating the insertion of new values.

Add Tag Values

Method: POST

URL: {{base_url}}/tag/value?mode=write


Query Parameters:

ParameterData TypeDescription

mode

string

Mode of the Request

  • read: Use this mode to retrieve data.

  • write: Use this mode to insert data.

(Default: mode=read)

updateStatus

bool

Update Status of data

  • true: Use this when need to update the status of data

  • false: Use this when don't need to update the status of data

(Default: updateStatus=false)

clearAll

bool

Clear records of data

  • true: Use this when need to clear all records of data before insert the new one

  • false: Use this when don't need to clear all records of data before insert the new one

(Default: clearAll=false)


Request Body:

The request body must be an array of tag value objects, each containing the following parameters:

ParameterData TypeDescription

tagname

string

Name of the tag to which the value belongs.

timeStamp

datetime

Timestamp of the value being written.

value

variant

Value associated with the tag. It can be one of the following data types:

Value Data Types:

Data TypeDescription

string

Represents text data.

int

Represents integer data.

double

Represents floating-point data.

bool

Represents boolean values (true/false).


Example Request Body:

[
    {
        "tagname": "string",
        "timeStamp": "datetime",
        "value": "variant"
    },
    {
        "tagname": "string",
        "timeStamp": "datetime",
        "value": "variant"
    }
]

Response Example:

{
    "message": "string"
}

Response Details:

ObjectData TypeDescription

message

string

Success message indicating the result of the write operation.

Last updated