This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

PUT /tag-by-name/{modelName}

Get tag by model name and tag name. Create it if it doesn’t exist already.

Parameters (path)

Name Required Description Values
modelName required Model name for the tag. Order, Partner, PartnerLocation, Sku, Recipe

Request body

Description

Data to store.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7

{
  "properties": {
    "format": "string",
    "example": "ABC123"
  },
  "type": "object"
}

Responses

201

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "readOnly": true,
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "color": {
        "description": "Color code of the tag",
        "type": "string",
        "format": "string",
        "enum": [
          "info",
          "muted",
          "success",
          "warning",
          "danger",
          "red",
          "blue",
          "green",
          "yellow",
          "purple",
          "brown"
        ],
        "example": "warning"
      },
      "class": {
        "description": "Class code of the tag",
        "type": "string",
        "format": "string",
        "enum": [
          "product_group",
          "brand",
          "phase",
          "size",
          "color",
          "automation",
          "region",
          "storage",
          "department"
        ],
        "example": "product_group"
      },
      "name": {
        "description": "Name of the tag",
        "type": "string",
        "format": "string",
        "example": "Customer"
      },
      "has_access_restrictions": {
        "description": "If this tag has special role based access restrictions",
        "type": "string",
        "format": "bool",
        "example": false
      },
      "lock_entity": {
        "description": "If entities that has this tag should be locked for editing",
        "type": "string",
        "format": "bool",
        "example": false
      },
      "comment": {
        "description": "Comment on the tag\nNotice that these will only be included if *comment* are included in the *include*-parameter",
        "type": "string",
        "format": "string",
        "example": "This tag serves the purpose of ..."
      },
      "models": {
        "description": "Models that this tag can be attached to. \nNotice that these will only be included if *models* are included in the *include*-parameter",
        "type": "array",
        "items": {
          "format": "string",
          "enum": [
            "Order",
            "Recipe",
            "Sku",
            "Partner",
            "Service",
            "OrderServiceLine"
          ],
          "example": "Order"
        }
      }
    },
    "type": "object"
  },
  "type": "object"
}

403

Unauthorized request

406

not acceptable

500

Internal server error