GET Gestalt/api/data/tags/{dsn}?name={name}&description={description}&unit={unit}&filter[0]={filter[0]}&filter[1]={filter[1]}&value[0]={value[0]}&value[1]={value[1]}&pageSize={pageSize}&page={page}

Performs a tag search on the specified data source.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dsn

The data source name.

string

Required

name

The tag name filter.

string

Default value is *

description

The tag description filter.

string

None.

unit

The tag unit filter.

string

None.

filter

A collection of additional data source-specific filter names to apply.

Collection of string

None.

value

A collection of additional data source-specific filter values to apply.

Collection of string

None.

pageSize

When greater than zero, specifies the page size setting to use with the query results.

integer

Default value is 20

page

When greater than zero, specifies the page number setting to use with the query results.

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

The content of a successful response will be a list of matching tags.

Collection of TagSearchResult
NameDescriptionTypeAdditional information
Id

Gets or sets the unique identifier for the tag. If not specified, the name of the tag will be used.

string

None.

Name

Gets or sets the tag name.

string

Required

Description

Gets or sets the tag description.

string

None.

UnitOfMeasure

Gets or sets the tag's unit of measure.

string

None.

Properties

Gets or sets the collection of properties associated with the tag.

Dictionary of string [key] and TagProperty [value]

None.

DigitalStates

Gets or sets the digital or enumerated states associated with the tag,

Collection of TagDigitalState

None.

IsMetaTag

Gets or sets a flag that specifies if the tag is a meta tag created by a driver.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "UnitOfMeasure": "sample string 4",
    "Properties": {
      "sample string 1": null,
      "sample string 2": null
    },
    "DigitalStates": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Value": 3
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Value": 3
      }
    ],
    "IsMetaTag": true
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "UnitOfMeasure": "sample string 4",
    "Properties": {
      "sample string 1": null,
      "sample string 2": null
    },
    "DigitalStates": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Value": 3
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Value": 3
      }
    ],
    "IsMetaTag": true
  }
]