Get tag by tagname

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

Last Update: 11 NOV 2024

Example URL

https://{api_base_url}/integration/webapi/tag/B15-Status

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

Retrieve Tag Information

Method: GET

URL: {{base_url}}/tag/{tagname}

Response Example:

{
    "data": [
        {
            "tagname": "string",
            "description": "string or null",
            "subDescription": "string or null",
            "tagType": "string",
            "tagSource": "string",
            "tagMode": "string",
            "unit": "string",
            "value": "string"
        }
    ]
}

Response Details:

ObjectData TypeDescription

data

array

List of tag objects, containing details of the specified tag.

tagname

string

Name of the tag.

description

string/null

Description of the tag.

subDescription

string/null

Sub-description of the tag, if available.

tagType

string

Data type of the tag (e.g., Integer, Double).

tagSource

string

Source of the tag data (e.g., Normal tag).

tagMode

string

Mode of the tag (e.g., Default).

unit

string

Unit of measurement for the tag, if applicable.

value

string

URL or current value of the tag.

Last updated