Tagsearch

Description

Provides tagname results based on provided search parameters.

The data returned by this entity is dependent on the historian’s implementation of search functionality. Some historians will return empty result sets.

It finds all the matching results for a given query string. It is basically used to filter the results based on the suggestion results. It searches for the matching record only on the fields provided in the key name as part of the query parameter. The results contain basic tag metadata information; such as FQN, tagname, source, and search ranking.

You can use these query options:

• q - Specifies the query string (for example, the value typed by the user into the search box).

• kn - Specifies the key name (field name) to which the search will be applied.

• kv - Specifies the key value which will be used for the search.

URL

/TagSearch

Method

GET 

Required Parameters

• FQN=[string ]
  The fully qualified name for the tag. A fully qualified name uses the format: datasource.tagname.

Optional Parameters

• Source=[string]
  The data source.

• TagName=[string]
  The name of the tag.

• DisplayText=[string]
  The displayed text for the tag.

• SearchRanking=[Double]
  The search ranking for this tag.

• Tag
  Returns a URL to retrieve a list of Tag entity values for the tags that match.

Sample Query

This example uses the "q", "kn", and "kv" query options.

https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/historian/v2/TagSearch
?q=r&kn=source&kv=atron