Lumada Data Catalog REST API Reference: Tags

Endpoints under /tag provide access to Tag objects in the Waterline Data repository. Tags are labels associated with data resources (folders, files, collections, or tables), or with specific fields in data resources.

A tag has a unique identifier ("key"), a label ("name"), and a description.
Tag names can use dot notation to identify a hierarchy of related tags.
Tags are organized into domains, represented by TagDomain objects.
The relationship between a tag and a resource or field is represented by a TagAssociation object.

POST /v2/tag

A POST request to the /tag endpoint creates a Tag object. You can make this call multiple times to add more than one tag, or create multiple tags with POST requests to the tag/list endpoint. You can create a tag in place in a hierarchy using the tag/hierarchy endpoint.

Request Body
media type	data type	description
application/json	Tag (JSON)	The body of the request contains a JSON object specifying at least "name", "domainKey", and "description".

Response Body
media type	data type	description
application/json	Tag (JSON)	The new Tag object in JSON format, containing the assigned unique identifying "key" value.

Example

Request

POST /v2/tag
Content-Type: application/json
Accept: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "ACCEPTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "REGEX",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "ACCEPTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "REGEX",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

GET /v2/tag/byname

A GET request to the /tag/byname endpoint retrieves a Tag object by tag domain and tag name.

Request Parameters
name	type	description
domainName	query	The name of the tag domain.
tagName	query	The name of the tag.

Response Body
media type	data type	description
application/json	Tag (JSON)	The Tag object in JSON format, containing the assigned unique identifying "key" value.

Example

Request

GET /v2/tag/byname
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "ACCEPTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "REJECTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "REGEX",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

POST /v2/tag/hierarchy

A POST request to the /tag/hierarchy endpoint creates all the tags needed to insert a tag in a branch of the hierarchy in a given domain. Tags in a hierarchy are identified with dot notation in the name ("parent.child.grandchild"). If parent tags in the hierarchy do not yet exist in the repository, they are generated by the call. For example, if the input includes a "name" value of "Organization.Property.Brand", the call creates three tags organized hierarchically, "Organization", "Property", and "Brand". The new tags are created as value tags.

Request Body
media type	data type	description
application/json	TagRequest (JSON)	A JSON object including the new tag name and domain key. It can include a tag description.

Response Body
media type	data type	description
application/json	Tag (JSON)

Example

Request

POST /v2/tag/hierarchy
Content-Type: application/json
Accept: application/json

                
{
  "sensitivity" : "...",
  "richDescription" : "...",
  "tagName" : "...",
  "domainKey" : "...",
  "description" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "SUGGESTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "VALUE",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

POST /v2/tag/list

A POST request to the /tag/list endpoint creates multiple Tag objects.

Request Body
media type	data type	description
application/json	array of Tag (JSON)	A JSON list containing a set of Tag objects, specifying at least the "name", "domainKey", and "state". The "name" value is a label string, limited to 2048 characters. The "domainKey" value is the unique identifying key of an existing TagDomain. The "description" value is a string of up to 2048 characters that describes the purpose of the tag. The "state" value is one of "ACCEPTED", "SUGGESTED", or "REJECTED".

Example

Request

POST /v2/tag/list
Content-Type: application/json

                
[ {
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "ACCEPTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "VALUE",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

Response

HTTP/1.1 201 Created

PUT /v2/tag/list

A PUT request to the /tag/list endpoint updates a set of tags.

Request Body
media type	data type	description
application/json	array of Tag (JSON)	A JSON list containing a set of Tag objects, specifying the tag key and the properties that are updated.

Example

Request

PUT /v2/tag/list
Content-Type: application/json

                
[ {
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "ACCEPTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "REGEX",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

Response

HTTP/1.1 204 No Content

GET /v2/tag/sensitivity

Response Body
media type	data type	description
application/json	array of string (JSON)

Example

Request

GET /v2/tag/sensitivity
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /v2/tag/{key}

A DELETE request to the /tag/{key} endpoint deletes a Tag object. All tag associations including this tag are also deleted.

Request Parameters
name	type	description	default	constraints
key	path	The unique identifier of the Tag object.
force	query		false	required

Example

Request

DELETE /v2/tag/{key}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /v2/tag/{key}

A GET request to the /tag/{key} endpoint retrieves a Tag object.

Request Parameters
name	type	description
key	path	The unique identifier of the Tag object.

Response Body
media type	data type	description
application/json	Tag (JSON)	The Tag object in JSON format.

Example

Request

GET /v2/tag/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "ACCEPTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "REJECTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "VALUE",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

PUT /v2/tag/{key}

A PUT request to the /tag/{key} endpoint updates the contents of an existing Tag.

Request Parameters
name	type	description
key	path	The unique identifier of the Tag object.

Request Body
media type	data type	description
application/json	Tag (JSON)	A JSON object specifying the new tag properties.

Response Body
media type	data type	description
application/json	Tag (JSON)	The updated Tag object in JSON format.

Example

Request

PUT /v2/tag/{key}
Content-Type: application/json
Accept: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "SUGGESTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "REJECTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "REGEX",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "REJECTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "ACCEPTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "REJECTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "REGEX",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "REGEX",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
}

GET /v2/tag/children/{key}

A GET request to the /tag/children/{key} endpoint retrieves all tags under a given tag in the tag hierarchy.

Request Parameters
name	type	description
key	path	The unique identifier of the Tag object.

Response Body
media type	data type	description
application/json	array of Tag (JSON)	An array of Tag objects, in JSON format.

Example

Request

GET /v2/tag/children/{key}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "regexMaxLen" : 12345,
  "parentKey" : "...",
  "allSensitivities" : [ "...", "..." ],
  "state" : "REJECTED",
  "immutable" : true,
  "synonyms" : [ "...", "..." ],
  "externalSourceName" : "...",
  "regEx" : "...",
  "fullName" : "...",
  "children" : [ {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "regexMaxLen" : 12345,
    "parentKey" : "...",
    "allSensitivities" : [ "...", "..." ],
    "state" : "SUGGESTED",
    "immutable" : true,
    "synonyms" : [ "...", "..." ],
    "externalSourceName" : "...",
    "regEx" : "...",
    "fullName" : "...",
    "children" : [ { }, { } ],
    "enable" : true,
    "domainKey" : "...",
    "externalId" : "...",
    "learningEnabled" : true,
    "name" : "...",
    "regexMinLen" : 12345,
    "regexFilterClass" : "...",
    "tagState" : "VALUE",
    "sensitivity" : "...",
    "minScore" : 12345.0,
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "enable" : true,
  "domainKey" : "...",
  "externalId" : "...",
  "learningEnabled" : true,
  "name" : "...",
  "regexMinLen" : 12345,
  "regexFilterClass" : "...",
  "tagState" : "VALUE",
  "sensitivity" : "...",
  "minScore" : 12345.0,
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "key" : "...",
  "description" : "...",
  "type" : "...",
  "restricted" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "richDescription" : "...",
  "score" : 12345.0,
  "customProperties" : [ {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  }, {
    "description" : "...",
    "value" : { },
    "facetAble" : true,
    "name" : "...",
    "type" : "...",
    "displayName" : "..."
  } ]
} ]

POST /v2/tag/regex/validate

A POST request to the /tag/regex/validate endpoint tests whether the regular expression provided for a tag is valid.

Request Body
media type	data type	description
application/json	RegexTester (JSON)	A JSON object including the context for testing the regular expression.

Response Body
media type	data type	description
application/json	boolean (JSON)	True if the test string matches the given pattern, false otherwise.

Example

Request

POST /v2/tag/regex/validate
Content-Type: application/json
Accept: application/json

                
{
  "maxLen" : 12345,
  "testString" : "...",
  "minLen" : 12345,
  "regex" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
...

Tags Resource

POST /v2/tag

Example

Request

Response

GET /v2/tag/byname

Example

Request

Response

POST /v2/tag/hierarchy

Example

Request

Response

POST /v2/tag/list

Example

Request

Response

PUT /v2/tag/list

Example

Request

Response

GET /v2/tag/sensitivity

Example

Request

Response

DELETE /v2/tag/{key}

Example

Request

Response

GET /v2/tag/{key}

Example

Request

Response

PUT /v2/tag/{key}

Example

Request

Response

GET /v2/tag/children/{key}

Example

Request

Response

POST /v2/tag/regex/validate

Example

Request

Response