This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /certification-schemes/{schemeId}
Get certification scheme
Description
Returns certification scheme
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| schemeId | required | Target scheme. |
Responses
200
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
{
"properties": {
"required": [
"name"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"code": {
"description": "Code for the scheme",
"type": "string",
"format": "string",
"example": "A string"
},
"name": {
"description": "Name of the scheme",
"type": "string",
"format": "string",
"example": "A string"
},
"show_in_ingredients": {
"description": "If this certification scheme schould be shown in ingredients",
"type": "string",
"format": "string",
"example": "A string"
},
"weight": {
"description": "In what order this scheme should be represented",
"type": "integer",
"format": "int32",
"example": 10
},
"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"
}
406
not acceptable
500
internal server error
PUT /certification-schemes/{schemeId}
Update existing Certification Scheme
Description
Update the specified resource in storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| schemeId | required | Target scheme. |
Request body
Description
CertificationScheme data.
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
{
"required": [
"name"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"code": {
"description": "Code for the scheme",
"type": "string",
"format": "string",
"example": "A string"
},
"name": {
"description": "Name of the scheme",
"type": "string",
"format": "string",
"example": "A string"
},
"show_in_ingredients": {
"description": "If this certification scheme schould be shown in ingredients",
"type": "string",
"format": "string",
"example": "A string"
},
"weight": {
"description": "In what order this scheme should be represented",
"type": "integer",
"format": "int32",
"example": 10
},
"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
{
"properties": {
"required": [
"name"
],
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"code": {
"description": "Code for the scheme",
"type": "string",
"format": "string",
"example": "A string"
},
"name": {
"description": "Name of the scheme",
"type": "string",
"format": "string",
"example": "A string"
},
"show_in_ingredients": {
"description": "If this certification scheme schould be shown in ingredients",
"type": "string",
"format": "string",
"example": "A string"
},
"weight": {
"description": "In what order this scheme should be represented",
"type": "integer",
"format": "int32",
"example": 10
},
"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 /certification-schemes/{schemeId}
Delete Certification Scheme
Description
Remove the specified resource from storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| schemeId | required | Target scheme. |
Responses
204
CertificationScheme was deleted
403
Unauthorized request
406
not acceptable
500
Internal server error