Represents a recurring working period, such as a morning, afternoon, or night shift. In the Excel templates, shifts are registered on the Shifts sheet.
Shifts let Pulse compare results across working periods.
Shifts are a shared entity. They work the same way in every manufacturing domain model.
The Shift object
{
"code": "SHIFT-MORNING",
"name": "Morning shift"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the shift in external systems and integrations. | "SHIFT-MORNING" |
name |
string | Human-readable name of the shift. | "Morning shift" |
Important
code must be unique. Two shifts cannot use the same code.
API resource
| Resource | Base path |
|---|---|
Shift |
/manufacturing/v1/shifts |
For the operations shared by all shared entities, see Shared entities API.
API methods
Create a shift
POST /manufacturing/v1/shifts/insert
Creates a new shift and returns its Pulse identifier.
Request
POST /manufacturing/v1/shifts/insert
Content-Type: application/json
{
"code": "SHIFT-MORNING",
"name": "Morning 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/v1/shifts/update
Updates an existing shift. The shift must already exist.
Request
PUT /manufacturing/v1/shifts/update
Content-Type: application/json
{
"code": "SHIFT-MORNING",
"name": "Morning shift (06:00–14:00)"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Business code of the shift to update. |
name |
string | yes | Human-readable name of the shift. |
Patch a shift
PATCH /manufacturing/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, which cannot be changed. Fields you leave out keep their current values.
Request
PATCH /manufacturing/v1/shifts/patch
Content-Type: application/json
{
"properties": {
"code": "SHIFT-MORNING",
"name": "Morning shift (06:00–14:00)"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Business code of the shift to update. |
properties.name |
string | no | New name of the shift. |
Retrieve a shift
GET /manufacturing/v1/shifts/select
Returns the shift identified by its business code. If no shift has this code, the response is empty.
Request
GET /manufacturing/v1/shifts/select?id=SHIFT-MORNING
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the shift to retrieve. |
Example response
{
"code": "SHIFT-MORNING",
"name": "Morning shift"
}
List shifts
GET /manufacturing/v1/shifts/query
Returns shifts matching the supplied filters.
Request
GET /manufacturing/v1/shifts/query?codes=SHIFT-MORNING
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. Upper and lower case are not distinguished. |
Example response
[
{
"code": "SHIFT-MORNING",
"name": "Morning shift"
}
]
Delete a shift
DELETE /manufacturing/v1/shifts/delete
Deletes the shift identified by its business code. If no shift has this code, nothing happens.
Request
DELETE /manufacturing/v1/shifts/delete?id=SHIFT-MORNING
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the shift to delete. |