Get tagrelation by tagrelation name

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

Last Update: 11 NOV 2024

Example URL

https://{api_base_url}/integration/webapi/tagrelation/bronze_relation_raw

Note: This endpoint demonstrates querying data for a specific tag relation (bronze_relation_raw). In this example, bronze_relation_raw is the tag relation name being queried.

Retrieve Tagrelation Information

Method: GET

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

Response Example:

{
    "data": {
        "tagRelationName": "string",
        "description": "string",
        "enableHyperTable": "string",
        "isView": "string",
        "sqlQueryScript": "string or null",
        "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.
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.
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.