Represents a production crew responsible for Food & Beverage operations.
For example, the team working the night shift on a production line can be registered as a Crew.
Crews provide operational context for Labor and production activity without identifying individual people.
The Crew object
{
"code": "CREW-C",
"name": "Night crew C"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the crew in external systems and integrations. | "CREW-C" |
name |
string | Human-readable name of the crew. | "Night crew C" |
Important
code must be unique. Two crews cannot use the same code.
See Types and attributes for guidance on extensible master-data properties.
API resource
| Resource | Base path |
|---|---|
Crew |
/manufacturing/food-beverage/v1/crews |
API methods
Create a crew
POST /manufacturing/food-beverage/v1/crews/insert
Creates a new crew.
Request
POST /manufacturing/food-beverage/v1/crews/insert
Content-Type: application/json
{
"code": "CREW-C",
"name": "Night crew C"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the crew. |
name |
string | yes | Human-readable name of the crew. |
Update a crew
PUT /manufacturing/food-beverage/v1/crews/update
Updates an existing crew.
Request
PUT /manufacturing/food-beverage/v1/crews/update
Content-Type: application/json
{
"code": "CREW-C",
"name": "Night crew C"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the crew to update. |
name |
string | yes | Human-readable name of the crew. |
Patch a crew
PATCH /manufacturing/food-beverage/v1/crews/patch
Partially updates an existing crew.
The fields to update are supplied in the properties object. The crew is identified by its business code.
Request
PATCH /manufacturing/food-beverage/v1/crews/patch
Content-Type: application/json
{
"properties": {
"code": "CREW-C",
"name": "Night crew C2"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Unique business code of the crew to update. |
properties.name |
string | no | New human-readable name of the crew. |
Retrieve a crew
GET /manufacturing/food-beverage/v1/crews/select
Returns the crew identified by its business code.
Request
GET /manufacturing/food-beverage/v1/crews/select?id=CREW-C
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the crew to retrieve. |
Example response
{
"code": "CREW-C",
"name": "Night crew C"
}
List crews
GET /manufacturing/food-beverage/v1/crews/query
Returns crews matching the supplied filters.
Crews can be filtered by code and name.
Request
GET /manufacturing/food-beverage/v1/crews/query?names=Night%20crew%20C
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codes |
string or array of strings | no | Limits results to crews with the specified business codes. |
names |
string or array of strings | no | Limits results to crews with the specified names. |
Example response
[
{
"code": "CREW-C",
"name": "Night crew C"
}
]
Delete a crew
DELETE /manufacturing/food-beverage/v1/crews/delete
Deletes the crew identified by its business code.
Request
DELETE /manufacturing/food-beverage/v1/crews/delete?id=CREW-C
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the crew to delete. |