Datapoint Tags

Owned by Nina Cardillo
10-Jan-2024
2 min read

Datapoint tags are optional key-value pairs, where the value for a key is optional.  Key-value pairs can be used for filtering a set of resources, such as datapoint lists. 

For example, a set of datapoints to be monitored in a Web page can be tagged with a unique key, and then all the datapoints for the page can be fetched with a single request specifying the unique key filter. A key is a string of up to 100 characters, and a value is a string of up to 64K characters. Tags are stored and maintained by the CMS. There are no default tags.

URI Definition

Method    

URI and Fields

GET



/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags/{tag_name}

Returns the specified tags as key-value pairs.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The tag_name path element allows you to specify a tag. 

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

POST


/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags

Adds one or multiple tags to a datapoint. The tags to be added are specified as key names, and optionally as "key"="value" pairs in the request data. If multiple tags are specified, they are separated by semicolons. Any tags that have already been added to the datapoint are ignored.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page. 

PUT


/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags/{tag_name}

Updates the tag value for the specified keys. If the key does not exist, the requested update for the key is ignored. If multiple tags are specified, they are separated by semicolons.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The tag_name path element allows you to specify a tag. 

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags/{tag_name}

Deletes one or multiple tags from a datapoint. The keys for the tags to be deleted are specified in the request data.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The tag_name path element allows you to specify a tag. 

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

Queries

You can include queries with your IAP/REST request to specify a selection rule for your request.  As described in Queries and Parameters, you can specify a query as a query parameter  appended to the end of your URI preceded with a "?" character, or as a path parameter within a path element of the path component.

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.