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

GET /recipes/{recipeId}

Get recipe

Description

Returns recipe

Parameters (path)

Name Required Description Values
recipeId required Target recipe.  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /recipes/{recipeId}

Update existing recipe

Description

Update the specified resource in storage.

Parameters (path)

Name Required Description Values
recipeId required Target recipe.  

Request body

Description

Target recipe.

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

{
  "required": [
    "name",
    "active"
  ],
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "description": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "locked": {
      "description": "No description is available",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "master_resource_id": {
      "description": "Id of the master resource. Used for MRP",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "name": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "preferred_interval": {
      "description": "Integer indicating the preferred interval of recipe units on a production order",
      "type": "boolean",
      "format": "int32",
      "example": 10
    },
    "ref": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "active": {
      "description": "Boolean indicating if the record is active and could be referenced from other entities",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "tag_ids": {
      "description": "Tag ids related to the Order entity. \nNotice that these will only be included if *tags* are included in the include parameter",
      "type": "array",
      "items": {
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      }
    },
    "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

403

Unauthorized request

406

not acceptable

500

Internal server error

DELETE /recipes/{recipeId}

Delete recipe

Description

Remove the specified resource from storage.

Parameters (path)

Name Required Description Values
recipeId required Target recipe.  

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error