Get multiple tagrelations values (with Body)

Fetches the values of specified tag relations based on the provided criteria.

Last Update: 7 NOV 2024

Example URL

https://{api_base_url}/integration/webapi/tagrelation/value?mode=read

Note: This endpoint demonstrates querying the value for a specific tag relation with the mode=read query parameter. In this example, the query specifies that the data should be retrieved in read mode.

Retrieve Tagrelation Values

Method: POST

URL: {{base_url}}/tagrelation/value?mode=read

---

Query Parameters:

Parameter	Data Type	Description
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:

Parameter	Data Type	Description
tagrelations	string	Comma-separated list of tag relation names to retrieve values for (e.g., bronze_relation_raw,TagRelationManagementSystem)
starttime	string	Starting time for filtering the data (e.g., *-10y) (Default: starttime=*-10m)
endtime	string	Ending time for filtering the data (e.g., *) (Default: endtime=*)
statusData	integer	Status filter for the tag relation values

---

Time Expression:

Expression	Description
sec	Second
m	Minute
h	Hour
d	Day
mo	Month
y	Year
-	Go back (e.g., *-10y means go back 10 years)
*	Present
+	Go forward (e.g., *+10mo means go forward 10 months)

---

Example Request Body:

{
    "tagrelations": "tagrelationname,tagrelationname",
    "starttime": "*-10y",
    "endtime": "*",
    "statusData": 9
}

---

Response Example:

{
    "data": [
        {
            "tagRelationName": "string",
            "Id": "string",
            "name": "string",
            "tel": "string",
            "quality": integer,
            "status": integer,
            "timeStamp": "datetime"
        }
    ]
}

Note: The fields Id, name, and tel are placeholders and will vary depending on the specific tag relation being represented in the request. Ensure you refer to the specific tag relation schema for exact field details.

Response Details:

Object	Data Type	Description
data	array	Array of tag relation value objects returned from the API.
tagRelationName	string	Name of the tag relation.
Id	string	Unique identifier for the tag relation.
name	string	Name associated with the tag relation.
tel	string	Telephone number associated with the tag relation.
quality	integer	Quality indicator of the tag relation value.
status	integer	Status code associated with the tag relation value.
timeStamp	datetime	Timestamp when the tag relation value was recorded.