This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
PUT /traces/{traceId}
Update existing Trace
Description
Update the specified resource in storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| traceId | required | Target trace. |
Request body
Description
Target Trace.
Required
This parameter is required.
Request body 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
{
"required": [
"origin_entity_id",
"origin_model_name",
"bring_forward",
"key",
"system"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"bring_forward": {
"description": "If the trace should be brought forward to successors of the lot (only available if origin entity is a lot)",
"type": "boolean",
"format": "boolean",
"example": false
},
"hide_on_documents": {
"description": "If the trace should be hidden on documents",
"type": "boolean",
"format": "boolean",
"example": false
},
"key": {
"description": "The key of the trace",
"type": "string",
"format": "string",
"example": "ABC1234"
},
"label": {
"description": "The lavel of the trace",
"type": "string",
"format": "string",
"example": "Track&trace number"
},
"link_entity_id": {
"description": "The entity to be linked to this trace. See *link_model_name*",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"link_model_name": {
"description": "Model name of the model this trace is linked to",
"type": "string",
"format": "string",
"enum": [
"PartnerCertificate",
"Partner"
],
"example": "PartnerCertificate"
},
"origin_entity_id": {
"description": "The id of the delivery or lot that this trace is attached to",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"origin_model_name": {
"description": "The model name that this trace is attached to",
"type": "string",
"format": "string",
"enum": [
"Delivery",
"Lot",
"Order"
],
"example": "Lot"
},
"system": {
"description": "The trace system",
"type": "string",
"format": "string",
"enum": [
"certificate",
"batch_number",
"lot_number",
"serial_number",
"container_number",
"pallet_number",
"track_and_trace",
"transport_event",
"owner",
"other",
"line_ref",
"control_body_code",
"customer",
"origin_raw_material"
],
"example": "batch_number"
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
{
"properties": {
"required": [
"origin_entity_id",
"origin_model_name",
"bring_forward",
"key",
"system"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"bring_forward": {
"description": "If the trace should be brought forward to successors of the lot (only available if origin entity is a lot)",
"type": "boolean",
"format": "boolean",
"example": false
},
"hide_on_documents": {
"description": "If the trace should be hidden on documents",
"type": "boolean",
"format": "boolean",
"example": false
},
"key": {
"description": "The key of the trace",
"type": "string",
"format": "string",
"example": "ABC1234"
},
"label": {
"description": "The lavel of the trace",
"type": "string",
"format": "string",
"example": "Track&trace number"
},
"link_entity_id": {
"description": "The entity to be linked to this trace. See *link_model_name*",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"link_model_name": {
"description": "Model name of the model this trace is linked to",
"type": "string",
"format": "string",
"enum": [
"PartnerCertificate",
"Partner"
],
"example": "PartnerCertificate"
},
"origin_entity_id": {
"description": "The id of the delivery or lot that this trace is attached to",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"origin_model_name": {
"description": "The model name that this trace is attached to",
"type": "string",
"format": "string",
"enum": [
"Delivery",
"Lot",
"Order"
],
"example": "Lot"
},
"system": {
"description": "The trace system",
"type": "string",
"format": "string",
"enum": [
"certificate",
"batch_number",
"lot_number",
"serial_number",
"container_number",
"pallet_number",
"track_and_trace",
"transport_event",
"owner",
"other",
"line_ref",
"control_body_code",
"customer",
"origin_raw_material"
],
"example": "batch_number"
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
500
Internal server error
DELETE /traces/{traceId}
Delete Trace
Description
Remove the specified resource from storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| traceId | required | Target trace. |
Responses
204
Trace was deleted
403
Unauthorized request
406
not acceptable
500
Internal server error