Represents a team that works together, for example the team that runs a line or a group of machines during a shift. In the Excel templates, crews are registered on the Crews sheet.
Crews describe who did the work without identifying individual people. Labour costs are booked against a crew.
Crews are a shared entity. They work the same way in every manufacturing domain model.
The Crew object
{
"code": "CREW-A",
"name": "Crew A"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the crew in external systems and integrations. | "CREW-A" |
name |
string | Human-readable name of the crew. | "Crew A" |
Important
code must be unique. Two crews cannot use the same code.
API resource
| Resource | Base path |
|---|---|
Crew |
/manufacturing/v1/crews |
For the operations shared by all shared entities, see Shared entities API.
API methods
Create a crew
POST /manufacturing/v1/crews/insert
Creates a new crew and returns its Pulse identifier.
Request
POST /manufacturing/v1/crews/insert
Content-Type: application/json
{
"code": "CREW-A",
"name": "Crew A"
}
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/v1/crews/update
Updates an existing crew. The crew must already exist.
Request
PUT /manufacturing/v1/crews/update
Content-Type: application/json
{
"code": "CREW-A",
"name": "Crew A (assembly)"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Business code of the crew to update. |
name |
string | yes | Human-readable name of the crew. |
Patch a crew
PATCH /manufacturing/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, which cannot be changed. Fields you leave out keep their current values.
Request
PATCH /manufacturing/v1/crews/patch
Content-Type: application/json
{
"properties": {
"code": "CREW-A",
"name": "Crew A (assembly)"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Business code of the crew to update. |
properties.name |
string | no | New name of the crew. |
Retrieve a crew
GET /manufacturing/v1/crews/select
Returns the crew identified by its business code. If no crew has this code, the response is empty.
Request
GET /manufacturing/v1/crews/select?id=CREW-A
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the crew to retrieve. |
Example response
{
"code": "CREW-A",
"name": "Crew A"
}
List crews
GET /manufacturing/v1/crews/query
Returns crews matching the supplied filters.
Request
GET /manufacturing/v1/crews/query?codes=CREW-A
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. Upper and lower case are not distinguished. |
Example response
[
{
"code": "CREW-A",
"name": "Crew A"
}
]
Delete a crew
DELETE /manufacturing/v1/crews/delete
Deletes the crew identified by its business code. If no crew has this code, nothing happens.
Request
DELETE /manufacturing/v1/crews/delete?id=CREW-A
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the crew to delete. |