TagController
Last updated
Last updated
Path /v2/tags
Handles all request regarding tags: creating, updating, deleting.
An example for a tag JSON object.
Responses are usually wrapped in a meta object, which contains additional information about the response and may contain a single tag or a list of tags.
id
global
created
updated
links - list of links to related resources
items
materials
components
parentTags
catalog - tha catalog this tag belongs to
label
language
items - list of item ids connected to this tag
tags - child tags
parents - parent tags
hidden - deprecated - superseded by visibilityStatus
visibilityStatus : possible values
0 : SHOWN (visible everywhere)
1 : SHOWN_IN_CMS (visible only in cms context)
2 : ARCHIVED (hidden everywhere)
id: identifier of a tag (deprecated)
tag_id : identifier of the tag
Translations can be multiple, we always return all the available translations in the form of multiple column pairs. If no translations are available, we insert in the CSV reference columns label_en and description_en.
label_{languageCode}: languageCode in ISO standard can be "en" or "de" for example and will be the current value of this language in the TagTranslation.
description_{languageCode}: languageCode in ISO standard can be "en" or "de" for example and will be the current value of this language in the TagTranslation.
png_icon: current png icon for this tag
svg_icon: current svg icon for this tag
inspiration_image: current inspiration image for this tag
global: is the tag global visible?
hidden: deprecated by visibilityStatus
visibilityStatus : possible values
0 : SHOWN (visible everywhere)
1 : SHOWN_IN_CMS (visible only in cms context)
2 : ARCHIVED (hidden everywhere)
sort: can be an integer or null, if there is no value for this field
material_ids: all connected material combined ids separated by ' ' (whitespace)
item_ids: all connected item combined ids separated by ' ' (whitespace)
component_ids: all connected component combined ids separated by ' ' (whitespace)
parent_tag_ids: ids of parent tags separated by ' ' (whitespace)
List of all tags matching the filter and visible to the Client
Generates: application/json
Query Parameters
ids[]
List of strings
filters the result to the given tag ids
catalogs[]
List of strings
filters the result to the given catalog ids
global
Boolean
If true returns only global tags, default is false
Creates a new tag in the catalog provided in the body.
Accepts: application/json Generates: application/json
Returns a specific tag.
Generates: application/json
Accepts: application/json Generates: application/json
updates assets on an tag
Accepts: multipart-formdata Generates: application/json
parameters:
the data, either as file or as URL. if both are provided, the URL is used
file : datafile to be uploaded
fileUrl: the publicly available url to the datafile
type: type of the asset
possible types are
"svgIcon"
"pngIcon"
"inspirationImage"
Deletes a specific tag.
Response (204 NO CONTENT): deleted
deletes an asset on a specific tag
possible types are
"svgIcon"
"pngIcon"
"inspirationImage"
Response (204 NO CONTENT): deleted
Generates: application/json
Returns all items which are assigned to this tag.
Generates: application/json
Returns all materials which are assigned to this tag.
Generates: application/json
Returns all components which are assigned to this tag.
Generates: application/json
Returns all parent tags of this tag.
Response (200 OK): Returns a list of .
Body:
Response (201 CREATED):
Response (200 OK):
Updates a specific tag. Assets needs to be uploaded explicitly (using ).
Body:
Response (200 OK): updated
Response (200 OK): updated with updated asset
For more information on the assets, please check
For more information on the assets, please check
Response (200 OK): List of
Response (200 OK): List of
Response (200 OK): List of
Response (200 OK): List of