Service: Tag
Reading and editing tags
All tag definitions are currently stored together in one file. However, the API maps the access to tags as if they were stored as individual Data Objects.
Functions
| Result | Name / Params | Comment | ||
|---|---|---|---|---|
| TagGetResult | tag.Get | Returns a list of all Tags | ||
| mode | DataMode | (Optional) View of the objects to return: raw or effective. Default is effective. | ||
| include | DataMode | (Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). | ||
| sort | DataSortItem[] | (Optional) Sorting definition as a list of properties with order. | ||
| offset | int | (Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination. | ||
Objects
Tag
| Property | Type | Description |
|---|---|---|
| Id | string | (Unique) Id of the tag. |
| Name | string | (Localized) The display name of the tag. |
TagGetResult
| Property | Type | Description |
|---|---|---|
| Objects | Tag[] | Array of Objects. |
| Pagination | Pagination | Describes the result set, if not all Objects were returned. |
Last modified September 25, 2026