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