Get Tag Relation by name

Fetches detailed information about a specific tag relation identified by its name.

Example URL

https://api.icube.co.th/integration/webapi/tagrelation/bronze_relation_raw

Last Update: 1 NOV 2024

Retrieve Tag Relation Information

Method: GET

URL: {{base_url}}/tagrelation/{tagrelationname}

Response Example:

{
    "data": {
        "tagRelationName": "string",
        "server": "string",
        "description": "string",
        "enableHyperTable": "string",
        "isView": "string",
        "sqlQueryScript": "string or null",
        "createAt": "datetime",
        "value": "string",
        "tagRelationFieldMappings": [
            {
                "fieldName": "string",
                "description": "string or null",
                "isIdentity": bool
            }
        ]
    }
}

Response Details:

Object	Data Type	Description
data	array	Contains details of the specified tag relation.
tagRelationName	string	Name of the tag relation.
server	string	Server name associated with the tag relation.
description	string	Description of the tag relation.
enableHyperTable	string	Indicates if hyper table functionality is enabled.
isView	string	Indicates if the tag relation is a view.
sqlQueryScript	string/null	SQL script associated with the tag relation, if available.
createAt	datetime	Creation timestamp for the tag relation.
value	string	URL or current value of the tag relation.
tagRelationFieldMappings	array	List of field mappings associated with the tag relation.
fieldName	string	Name of the field in the mapping.
description	string/null	Description of the field, if available.
isIdentity	bool	Indicates if the field is an identity field.