Represents a tank, silo, or other process vessel associated with a production line.
For example, a fermentation tank, mixing vessel, or ingredient silo can be registered as a Vessel.
A vessel belongs to a production line and can act as a carryover scope between production batches.
The Vessel object
{
"code": "TANK-3",
"name": "Fermentation tank 3",
"parent": "LINE001"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the vessel in external systems and integrations. | "TANK-3" |
name |
string | Human-readable name of the vessel. | "Fermentation tank 3" |
parent |
string | Business code of the production line the vessel belongs to or feeds. | "LINE001" |
Important
code must be unique. Two vessels cannot use the same code.
The production line referenced by parent must already exist before the vessel is submitted.
See Types and attributes for guidance on extensible master-data properties.
API resource
| Resource | Base path |
|---|---|
Vessel |
/manufacturing/food-beverage/v1/vessels |
API methods
Create a vessel
POST /manufacturing/food-beverage/v1/vessels/insert
Creates a new vessel.
Request
POST /manufacturing/food-beverage/v1/vessels/insert
Content-Type: application/json
{
"code": "TANK-3",
"name": "Fermentation tank 3",
"parent": "LINE001"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the vessel. |
name |
string | yes | Human-readable name of the vessel. |
parent |
string | yes | Business code of the production line the vessel belongs to or feeds. |
Update a vessel
PUT /manufacturing/food-beverage/v1/vessels/update
Updates an existing vessel.
Request
PUT /manufacturing/food-beverage/v1/vessels/update
Content-Type: application/json
{
"code": "TANK-3",
"name": "Fermentation tank 3",
"parent": "LINE002"
}
Changing parent moves the vessel to another production line.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the vessel to update. |
name |
string | yes | Human-readable name of the vessel. |
parent |
string | yes | Business code of the production line the vessel belongs to or feeds. |
Patch a vessel
PATCH /manufacturing/food-beverage/v1/vessels/patch
Partially updates an existing vessel.
The fields to update are supplied in the properties object. The vessel is identified by its business code.
Request
PATCH /manufacturing/food-beverage/v1/vessels/patch
Content-Type: application/json
{
"properties": {
"code": "TANK-3",
"name": "Fermentation tank 3",
"parent": "LINE002"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Unique business code of the vessel to update. |
properties.name |
string | no | New human-readable name of the vessel. |
properties.parent |
string | no | Business code of the production line the vessel should belong to. |
Retrieve a vessel
GET /manufacturing/food-beverage/v1/vessels/select
Returns the vessel identified by its business code.
Request
GET /manufacturing/food-beverage/v1/vessels/select?id=TANK-3
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the vessel to retrieve. |
Example response
{
"code": "TANK-3",
"name": "Fermentation tank 3",
"parent": "LINE001"
}
List vessels
GET /manufacturing/food-beverage/v1/vessels/query
Returns vessels matching the supplied filters.
Vessels can be filtered by code, name, and parent production line.
Request
GET /manufacturing/food-beverage/v1/vessels/query?parents=LINE001
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codes |
string or array of strings | no | Limits results to vessels with the specified business codes. |
names |
string or array of strings | no | Limits results to vessels with the specified names. |
parents |
string or array of strings | no | Limits results to vessels belonging to the specified production lines. |
Example response
[
{
"code": "TANK-3",
"name": "Fermentation tank 3",
"parent": "LINE001"
},
{
"code": "TANK-4",
"name": "Fermentation tank 4",
"parent": "LINE001"
}
]
Delete a vessel
DELETE /manufacturing/food-beverage/v1/vessels/delete
Deletes the vessel identified by its business code.
Request
DELETE /manufacturing/food-beverage/v1/vessels/delete?id=TANK-3
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the vessel to delete. |