Tag API reference guide
This page describes the tag endpoint. When implemented, this standard REST interface can tag new data sources automatically.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
POST /tag
Create a new tag.
name
string The name of the tag.
Yes
id
integer The tag ID.
No
rootTag
array When provided, indicates the name of the root (or parent) tag that the child tag will fall under. If a child tag is added, the deleteHierarchy value will be true.
No
id
integer The tag ID.
color
string An uneditable tag field.
description
string An uneditable tag field that appears as a tag description in the UI. Built-in tags come with descriptions pre-populated.
name
string The tag name.
source
string The system the tag was created by. When curated, the tag was created in Immuta.
deleted
boolean If true, the tag has been deleted.
systemCreated
boolean When true, the tag was created by Immuta.
createdBy
string The profile ID of the creator.
createdAt
timestamp The date and time of the tag creation.
updatedAt
timestamp The date and time of the tag update.
The following request creates a new tag.
GET /tag
Search across all tags.
searchText
string A string used to filter returned tags. The query is executed with a wildcard prefix and suffix.
No
source
string Filter tags by the source that created them.
No
excludedSource
string Only return tags that do not have this source.
No
includeAllSystemTags
boolean If true, includes all system tags even if they have been deleted. Otherwise, set to false to filter out all system-created tags.
No
excludedHierarchies
Array[string] A string used to filter returned tags. The query is executed with a wildcard prefix and suffix.
No
limit
integer The maximum number of search results that will be returned.
No
id
integer The tag ID.
name
string The tag name.
color
string An uneditable tag field.
description
string An uneditable tag field that appears as a tag description in the UI. Built-in tags come with descriptions pre-populated.
source
string The system the tag was created by. When curated, the tag was created in Immuta.
deleted
boolean If true, the tag has been deleted.
systemCreated
boolean When true, the tag was created by Immuta.
The following request searches all tags.
/tag/refresh
/tag/{modelType}/{modelId}
POST /tag/refresh
Refresh external tags.
The following request refreshes external tags.
POST /tag/{modelType}/{modelId}
Add tags to a particular model. No tags will be processed if any invalid tags are found in the payload.
modelType
string The Immuta component to add the tag to: datasource, column, or project.
Yes
modelId
string The ID of the column, data source, or project. Note: The modelId for a column is the data source ID followed by _OBJECTID (For example, 49_OBJECTID).
Yes
No tags will be processed if any invalid tags are found in the payload.
name
string The name of the tag.
Yes
id
integer The tag ID.
No
displayName
string The tag's name that is displayed in the console.
No
source
string The name of the system that created the tag. When curated, the tag was created in Immuta.
No
systemCreated
boolean When true, the tag was created by Immuta.
No
addedBy
integer The profile ID of the user who added the tag to the data source, column, or project.
No
deleted
boolean When true, the tag has been deleted.
No
hasLeafNodes
boolean When true, parent tags exist within the tag hierarchy that have no child tags.
No
createdBy
integer The profile ID of the user who created the tag.
No
createdAt
date When the tag was created.
No
updatedAt
date When the tag was last updated.
No
name
string The name of the tag.
source
string The system the tag was created by. When curated, the tag was created in Immuta.
addedBy
integer The profile ID of the user who added the tag.
deleted
boolean When true, the tag has been deleted.
Request example
The following request adds tags to the data source with the data source ID 22.
Request payload example
Response example
Request example
The following request adds tags to the project with the project ID 2.
Request payload example
Response example
Request example
The following request adds tags to the countrycode column of the data source with the data source ID 6.
Request payload example
Response example
/tag/{tag}
/tag/{modelType}/{modelId}/{tag}
DELETE /tag/{tag}
Delete a tag.
tag
string The name of the tag.
Yes
deleteHierarchy
boolean If true it will delete the entire hierarchy.
No
id
integer The tag ID.
name
string The tag name.
color
string An uneditable tag field.
description
string An uneditable tag field that appears as a tag description in the UI. Built-in tags come with descriptions pre-populated.
source
string The system the tag was created by. When curated, the tag was created in Immuta.
deleted
boolean If true, the tag has been deleted.
systemCreated
boolean When true, the tag was created by Immuta.
createdBy
string The profile ID of the creator.
createdAt
timestamp The date and time of the tag creation.
updatedAt
timestamp The date and time of the tag update.
The following request deletes a tag.
DELETE /tag/{modelType}/{modelId}/{tag}
Delete tags from a particular model.
tag
string The name of the tag.
Yes
modelType
string The model type.
Yes
modelId
string The ID of the column, data source, or project. Note: The modelId for a column is the data source ID followed by _OBJECTID (For example, 49_OBJECTID).
Yes
The following request deletes a tag.
.
.
.
.