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

GET /recipes

Get list of Recipes

Description

Returns list of Recipes

Parameters (query)

Name Required Description Values
sortBy optional Field to sort by.  
sortDirection optional Direction of sort. asc, desc
keyword[eq] optional Search for . Allowed expression(s): eq, ct  
active[eq] optional Search for . Allowed expression(s): eq  
produces[eq] optional Search for a recipe by the sku id it produces. Allowed expression(s): eq, in  
produces[eq] optional Search for a recipe by the sku id it consumes. Allowed expression(s): eq, in  
tags[eq] optional Search for recipe by tags. Allowed expression(s): eq, in  
include optional The resources that can be included in this request, delimited by a comma: consumes, produces, steps, budgets, master_resource, tags  

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
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

{
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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"
      }
    },
    "links": {
      "description": "Links",
      "properties": {
        "first": {
          "description": "Link to the first page",
          "type": "string"
        },
        "last": {
          "description": "Link to the last page",
          "type": "string"
        },
        "next": {
          "description": "Link to the next page",
          "type": "string"
        },
        "prev": {
          "description": "Link to the previous page",
          "type": "string"
        }
      },
      "type": "object"
    },
    "meta": {
      "description": "Meta with pagination",
      "properties": {
        "current_page": {
          "description": "The current page",
          "type": "integer"
        },
        "from": {
          "description": "The starting position of the current page results",
          "type": "integer"
        },
        "last_page": {
          "description": "The last page",
          "type": "integer"
        },
        "path": {
          "description": "The current path of the request",
          "type": "string"
        },
        "per_page": {
          "description": "Records that are displayed pr request",
          "type": "integer"
        },
        "to": {
          "description": "The ending position of the current page results",
          "type": "integer"
        },
        "total": {
          "description": "Number of records that are matched by the current query",
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

406

not acceptable

500

internal server error

POST /recipes

Create new Recipe

Description

Create a new 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

406

not acceptable

500

internal server error