Represents a defined cleaning procedure used in Food & Beverage operations.
For example, allergen cleaning, a full clean-in-place (CIP) cycle, or a dry-cleaning procedure can each be registered as a Clean regime.
Clean regimes allow comparable cleaning activities to be classified consistently.
The Clean regime object
{
"code": "allergen-cip",
"name": "Allergen CIP"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the cleaning regime. | "allergen-cip" |
name |
string | Human-readable name of the cleaning regime. | "Allergen CIP" |
Important
code must be unique. Two cleaning regimes cannot use the same code.
API resource
| Resource | Base path |
|---|---|
Clean regime |
/manufacturing/food-beverage/v1/clean-regimes |
API methods
Create a clean regime
POST /manufacturing/food-beverage/v1/clean-regimes/insert
Creates a new cleaning regime.
Request
POST /manufacturing/food-beverage/v1/clean-regimes/insert
Content-Type: application/json
{
"code": "allergen-cip",
"name": "Allergen CIP"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the cleaning regime. |
name |
string | yes | Human-readable name of the cleaning regime. |
Update a clean regime
PUT /manufacturing/food-beverage/v1/clean-regimes/update
Updates an existing cleaning regime.
Request
PUT /manufacturing/food-beverage/v1/clean-regimes/update
Content-Type: application/json
{
"code": "allergen-cip",
"name": "Validated allergen CIP"
}
Patch a clean regime
PATCH /manufacturing/food-beverage/v1/clean-regimes/patch
Partially updates an existing cleaning regime.
The fields to update are supplied in the properties object. The cleaning regime is identified by its business code.
Request
PATCH /manufacturing/food-beverage/v1/clean-regimes/patch
Content-Type: application/json
{
"properties": {
"code": "allergen-cip",
"name": "Validated allergen CIP"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Unique business code of the cleaning regime to update. |
properties.name |
string | no | New human-readable name of the cleaning regime. |
Retrieve a clean regime
GET /manufacturing/food-beverage/v1/clean-regimes/select
Returns the cleaning regime identified by its business code.
Request
GET /manufacturing/food-beverage/v1/clean-regimes/select?id=allergen-cip
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the cleaning regime to retrieve. |
Example response
{
"code": "allergen-cip",
"name": "Allergen CIP"
}
List clean regimes
GET /manufacturing/food-beverage/v1/clean-regimes/query
Returns cleaning regimes matching the supplied filters.
Request
GET /manufacturing/food-beverage/v1/clean-regimes/query?names=Allergen%20CIP
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codes |
string or array of strings | no | Limits results to cleaning regimes with the specified business codes. |
names |
string or array of strings | no | Limits results to cleaning regimes with the specified names. |
Example response
[
{
"code": "allergen-cip",
"name": "Allergen CIP"
}
]
Delete a clean regime
DELETE /manufacturing/food-beverage/v1/clean-regimes/delete
Deletes the cleaning regime identified by its business code.
Request
DELETE /manufacturing/food-beverage/v1/clean-regimes/delete?id=allergen-cip
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the cleaning regime to delete. |