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.
Tagging workflow
Create a new tag
POST /tag
Create a new tag.
Payload parameters
Response parameters
Request example
The following request creates a new tag.
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
--data @example_payload.json \
https://your-immuta-url.com/tag
Payload example
{
"tags": [{
"name": "Address.email"
}, {
"name": "Address.work"
}, {
"name": "Address.home"
}]
}
Response example
[{
"id": 129,
"name": "Address.email",
"color": null,
"description": null,
"source": "curated",
"deleted": false,
"systemCreated": false,
"createdBy": 2,
"createdAt": "2021-10-08T20:53:22.946Z",
"updatedAt": "2021-10-08T20:53:22.946Z"
}, {
"id": 130,
"name": "Address.home",
"color": null,
"description": null,
"source": "curated",
"deleted": false,
"systemCreated": false,
"createdBy": 2,
"createdAt": "2021-10-08T20:53:22.946Z",
"updatedAt": "2021-10-08T20:53:22.946Z"
}, {
"id": 131,
"name": "Address.work",
"color": null,
"description": null,
"source": "curated",
"deleted": false,
"systemCreated": false,
"createdBy": 2,
"createdAt": "2021-10-08T20:53:22.946Z",
"updatedAt": "2021-10-08T20:53:22.946Z"
}]
Search across all tags
GET /tag
Search across all tags.
Query parameters
Response parameters
Request example
The following request searches all tags.
curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://your-immuta-url.com/tag
Response example
[
{
"id": 114,
"name": "DataProperties.Cross-Sectional",
"color": null,
"description": null,
"source": "curated",
"deleted": false,
"systemCreated": true
},
{
"id": 2,
"name": "Discovered.Country.Argentina",
"color": null,
"description": null,
"source": "curated",
"deleted": false,
"systemCreated": true
},
{
"id": 9,
"name": "Discovered.Country.Australia",
"color": null,
"description": null,
"source": "curated",
"deleted": false,
"systemCreated": true
},
]
Update tags
Refresh external tags
POST /tag/refresh
Refresh external tags.
Request example
The following request refreshes external tags.
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://your-immuta-url.com/tag/refresh
Add tags to a particular model
POST /tag/{modelType}/{modelId}
Add tags to a particular model. No tags will be processed if any invalid tags are found in the payload.
Query parameters
Payload parameters
No tags will be processed if any invalid tags are found in the payload.
Response parameters
Add tags to a data source
Request example
The following request adds tags to the data source with the data source ID 22.
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
--data @example_payload.json \
https://your-immuta-url.com/tag/datasource/22
Request payload example
[{
"name": "Discovered.Passport",
"source": "curated"
}]
Response example
[{
"name": "Discovered.Passport",
"source": "curated",
"addedBy": 2,
"deleted": false
}]
Add tags to a project
Request example
The following request adds tags to the project with the project ID 2.
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
--data @example_payload.json \
https://your-immuta-url.com/tag/project/2
Request payload example
[{
"name": "Confidential",
"source": "curated"
}]
Response example
[{
"name": "Confidential",
"source": "curated",
"context": "manual",
"addedBy": 2,
"deleted": false
}]
Add tags to a data source column
Request example
The following request adds tags to the countrycode column of the data source with the data source ID 6.
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
--data @example_payload.json \
https://your-immuta-url.com/tag/column/6_countrycode
Request payload example
[{
"name": "Discovered.Passport",
"source": "curated"
}]
Response example
[{
"name":"Discovered.Passport",
"source":"curated",
"context":"manual",
"addedBy":2,
"deleted":false
}]
Delete tags
Delete a tag
DELETE /tag/{tag}
Delete a tag.
Query parameters
Response parameters
Request example
The following request deletes a tag.
curl \
--request DELETE \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://your-immuta-url.com/tag/DataProperties.Cross-Sectional
Response example
[
{
"id": 114,
"name": "DataProperties.Cross-Sectional",
"color": null,
"description": null,
"source": "curated",
"deleted": true,
"systemCreated": true,
"createdBy": null,
"createdAt": "2021-06-24T15:08:53.119Z",
"updatedAt": "2021-09-27T19:00:38.828Z"
}
]
Delete tags from a particular model
DELETE /tag/{modelType}/{modelId}/{tag}
Delete tags from a particular model.
Query parameters
Request example
The following request deletes a tag.
curl \
--request DELETE \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://your-immuta-url.com/tag/datasource/523/Discovered.Country.Canada
