Tags
Assign and manage tags for dataset organization and discovery.
GET /api/datasets/{id}/tags
Get all tags assigned to a dataset.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Dataset ID or slug |
Response:
{
"_links": {
"self": { "href": "/api/datasets/{id}/tags" }
},
"_embedded": {
"inf:tag-entity": [
{
"id": "tag-finance",
"name": "Finance",
"color": "#FF5733",
"description": "Financial data and reports",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"id": "tag-quarterly",
"name": "Quarterly",
"color": "#3498DB",
"description": "Quarterly reporting data",
"createdAt": "2024-01-01T00:00:00Z"
}
]
},
"start": 0,
"count": 2,
"total": 2
}
GET /api/datasets/{id}/tags/{tagId}
Get a single tag assignment.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Dataset ID or slug |
tagId | string | Tag ID |
Response:
{
"id": "tag-finance",
"name": "Finance",
"color": "#FF5733",
"description": "Financial data and reports",
"datasetId": "sales-2024",
"assignedAt": "2024-01-15T10:00:00Z",
"assignedBy": "user:admin"
}
PUT /api/datasets/{id}/tags/{tagId}
Assign a tag to a dataset.
Authentication: Required
Permission: dataset:assignTags
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Dataset ID or slug |
tagId | string | Tag ID to assign |
Response:
{
"id": "tag-finance",
"name": "Finance",
"datasetId": "sales-2024",
"assignedAt": "2024-02-08T16:00:00Z",
"assignedBy": "user:admin"
}
DELETE /api/datasets/{id}/tags/{tagId}
Remove a tag assignment from a dataset.
Authentication: Required
Permission: dataset:assignTags
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Dataset ID or slug |
tagId | string | Tag ID to remove |
Response:
204 No Content
Tag Organization Examples
Department Tags
const departments = ['tag-finance', 'tag-sales', 'tag-marketing', 'tag-operations'];
for (const tagId of departments) {
await PUT(`/api/datasets/sales-2024/tags/${tagId}`);
}
Frequency Tags
// Mark as daily refresh dataset
await PUT('/api/datasets/sales-2024/tags/tag-daily');
// Mark as quarterly report
await PUT('/api/datasets/financial-q1/tags/tag-quarterly');
Data Quality Tags
// Mark as verified
await PUT('/api/datasets/customer-data/tags/tag-verified');
// Mark as draft
await PUT('/api/datasets/test-data/tags/tag-draft');
Best Practices
- Use consistent tags across datasets
- Limit tag count per dataset (5-10 max)
- Color code by category for visual organization
- Create tag hierarchy with naming conventions
- Document tag meanings for team consistency