Tags API
The Tags API retrieves the qualified tag name list by a given
nameMask.Note: URI format supports asterisks (*) and question marks (?).
| METHOD | GET |
| URI | https://<historianservername>:8443/historian-rest-api/v1/tags/{nameMask}/{maxNumber} |
| SAMPLE URI | https://<historianservername>:8443/historian-rest-api/v1/tags?nameMask=*&maxNumber=100 |
| SAMPLE cURL COMMAND | curl -i -H "Accept: application/json" -H "Authorization: Bearer <TOKEN> https://<nodename>:8443/ historian-rest-api/v1/tags?nameMask=*&maxNumber=<Number_Of_Tags> |
Query Parameters
| Parameter | Description | Required? | Values |
|---|---|---|---|
nameMask | Tagmask that searches for all tags that match the mask and applies the remaining criteria to retrieve data. The mask can include wildcards, such as asterisks (*). | Optional | String |
maxNumber | Maximum tag number provides the limit while returning the results (0 by default). This means that for a query, if using 0, all tags are returned. If a negative number is used, then 0 is used for the maxNumber. If a positive number is used, then that number of tags is returned. In addition, an error number of +14 notifies the user that there are more than the requested number of tags in the system. | Optional | Integer 0 by default |
Response Parameters
| Parameter | Data Type | Required? | Description |
|---|---|---|---|
| ErrorCode | Number | Yes | For example, ErrorCode = 0, which means the operation was successful. |
| ErrorMessage | String | Yes | For example, NULL. |
| tags | String | Yes | Includes the following:
|
Sample Response
{
"ErrorCode":0,
"ErrorMessage": null,
"tags": [
"ALT_SENSOR",
"tagName1",
"tagName2"
]
}