Skip to content
Documentation

Working with Attributes

Attributes are metadata that can be assigned to time series. They allow time series to be categorized, filtered, and grouped.

GET /repositories/{repository}/attributes
Parameter Type Default Required Description
name string — Filter by attribute name.
description string — Filter by description.
type string — Filter by attribute type.
order string — Sort results. Same behavior as for time series search results.
Range string — Paginate results with the Range request header (e.g., attribute=0-49). Same behavior as for time series search results.

Request

POST /repositories/{repository}/attributes

Request Body

{
"name": "Location",
"description": "Geographic location of the measurement",
"type": {
"identifier": 2,
"storageInformation": {
"repositoryName": "TSM_SQLSERVER"
}
}
}
GET /repositories/{repository}/attributes/{attribute}

In the endpoint GET /repositories/{repository}/attributes/{attribute}, the {attribute} path segment accepts the attribute name or an ID prefixed with id:.

flask Equivalent attribute loading requests

Section titled “ Equivalent attribute loading requests”

Given the following attribute:

{
"identifier": 1012,
"storageInformation": {
"repositoryName": "TSM_SQLSERVER"
},
"value": {
"name": "MyAttribute",
"description": "",
"type": {
"identifier": 4,
"storageInformation": {
"repositoryName": "TSM_SQLSERVER"
}
}
}
}

Loading it by name:

GET /repositories/TSM_SQLSERVER/attributes/MyAttribute

Loading it by ID:

GET /repositories/TSM_SQLSERVER/attributes/id:1012
PUT /repositories/{repository}/attributes/{attribute}

This request uses the same body as the Attribute Creation.

DELETE /repositories/{repository}/attributes/{attribute}

To force deletion even when the attribute is still assigned to time series:

DELETE /repositories/{repository}/attributes/{attribute}?force=true
© 2026 Volue.Version v0.6.38017 November 2026