Tagsuggest

Description

Retrieves content or tags based on search criteria from AVEVA Insight. It returns the search results based on tag name, content name, keywords, description, and so on. It also returns the summary of the search result -- for example, total matching search results for the given search text.

You can use the these query options:

• q -- (query) Limits the search to only specified fields instead of searching all fields.

• Type -- Limits the search to only a certain type of data (Tag or SavedContent).

URL

/TagSuggest

Method

GET 

Required Parameters

• Value=[string ]
  The suggested value.

Optional Parameters

• FieldName=[string]
  The related field name.

• Count=[Double]
  The hit count for this query string.

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

• DisplayText=[string]
  The associated display text.

• Search
  

• Tags
  Identifies related Tags.

• ExpandSuggest
  

Sample Query

Scenario 1

This query returns values from a search of all fields (default).

https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/historian/v2/TagSuggest

Scenario 2

This query uses the "q" query option to limit the search to only the "location" field.

https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/historian/v2/TagSuggest
?q=&searchfields=location

Scenario 3

This query uses the "Type" option to limit the search to only a certain type of data (Tag or SavedContent).

https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/historian/v2/TagSuggest?q=d&Type=Tag