Tag Data Type

Type that describes a tag, including the tag name and properties that describe how the tag is used in tag association discovery.

Abstract Type
Properties
name data type description
children array of Tag
domainKey string
parentKey string
name string
tagState TagState
minScore number
regEx string
regexMinLen number
regexMaxLen number
regexFilterClass string
learningEnabled boolean
immutable boolean
enable boolean
fullName string
state State
externalId string
externalSourceName string
synonyms array of string
Properties inherited from Entity
key string
type string
description string
timeOfLastChange number
timeOfCreation number
restricted array of string
updateable array of string
viewAble array of string
customProperties array of CustomProperty

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "children" : [ {
    "children" : [ { }, { } ],
    "domainKey" : "...",
    "parentKey" : "...",
    "name" : "...",
    "tagState" : "REGEX",
    "minScore" : 12345.0,
    "regEx" : "...",
    "regexMinLen" : 12345,
    "regexMaxLen" : 12345,
    "regexFilterClass" : "...",
    "learningEnabled" : true,
    "immutable" : true,
    "enable" : true,
    "fullName" : "...",
    "state" : "ACCEPTED",
    "externalId" : "...",
    "externalSourceName" : "...",
    "synonyms" : [ "...", "..." ],
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  }, {
    "children" : [ { }, { } ],
    "domainKey" : "...",
    "parentKey" : "...",
    "name" : "...",
    "tagState" : "VALUE",
    "minScore" : 12345.0,
    "regEx" : "...",
    "regexMinLen" : 12345,
    "regexMaxLen" : 12345,
    "regexFilterClass" : "...",
    "learningEnabled" : true,
    "immutable" : true,
    "enable" : true,
    "fullName" : "...",
    "state" : "ACCEPTED",
    "externalId" : "...",
    "externalSourceName" : "...",
    "synonyms" : [ "...", "..." ],
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  } ],
  "domainKey" : "...",
  "parentKey" : "...",
  "name" : "...",
  "tagState" : "VALUE",
  "minScore" : 12345.0,
  "regEx" : "...",
  "regexMinLen" : 12345,
  "regexMaxLen" : 12345,
  "regexFilterClass" : "...",
  "learningEnabled" : true,
  "immutable" : true,
  "enable" : true,
  "fullName" : "...",
  "state" : "REJECTED",
  "externalId" : "...",
  "externalSourceName" : "...",
  "synonyms" : [ "...", "..." ],
  "key" : "...",
  "type" : "...",
  "description" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "restricted" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "customProperties" : [ {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  }, {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  } ]
}