Skip to main content

1E 8.1 (on-premises)

Tagging.GetAll

Module

Tagging

Method

GetAll

Library

Core

Action

Fetch the tag list (containing all tags) of the specified type.

Parameters

Scopable (boolean; optional):

  • true - Get the list of Device tags (default)

  • false - Get the list of a Freeform tags

Return values

Values (string): A single string with all tags formatted as in an online message, ordered alphabetically by name. The format is "|name1=value1|name2=value2|...|namen=valuen|", i.e. name-value pairs are separated by the '=' character, and vertical bars separate each name-value pair and also start and end the list. The "alphabetical" order is not rigidly defined. An empty list (i.e. when there are no tags of that type at all) results in "||".

Note

Tag names are stored internally in upper case, and so they are also listed in that form.

Count (int): The number of key-value pairs that exist for the specified tag type. This will return the same information as Tagging.Count(). v3.0.100+

Length(int): The length of the tag string as stored by the agent. v3.0.100+

Example

// Get all freeform tags 
Tagging.GetAll(Scopable: false);
 
// Get all device tags, using default Scopable:true
Tagging.GetAll();

Platforms

  • Windows

  • Linux

  • MacOS

Notes