Represents a physical operating location in Pulse, for example a plant or a production facility. In the Excel templates, sites are registered on the Sites sheet.
A site is the root of the manufacturing hierarchy. The production structure of each domain model, such as production lines or work centres, belongs to a site.
Sites are a shared entity. They work the same way in every manufacturing domain model.
The Site object
{
"code": "PLANT-NORTH",
"name": "North plant"
}
Fields
| Field | Type | Description | Example |
|---|---|---|---|
code |
string | Unique business code used to identify the site in external systems and integrations. | "PLANT-NORTH" |
name |
string | Human-readable name of the site. | "North plant" |
Important
code must be unique. Two sites cannot use the same code.
API resource
| Resource | Base path |
|---|---|
Site |
/manufacturing/v1/sites |
For the operations shared by all shared entities, see Shared entities API.
API methods
Create a site
POST /manufacturing/v1/sites/insert
Creates a new site and returns its Pulse identifier.
Request
POST /manufacturing/v1/sites/insert
Content-Type: application/json
{
"code": "PLANT-NORTH",
"name": "North plant"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Unique business code of the site. |
name |
string | yes | Human-readable name of the site. |
Update a site
PUT /manufacturing/v1/sites/update
Updates an existing site. The site must already exist.
Request
PUT /manufacturing/v1/sites/update
Content-Type: application/json
{
"code": "PLANT-NORTH",
"name": "North production plant"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
code |
string | yes | Business code of the site to update. |
name |
string | yes | Human-readable name of the site. |
Patch a site
PATCH /manufacturing/v1/sites/patch
Partially updates an existing site.
The fields to update are supplied in the properties object. The site is identified by its business code, which cannot be changed. Fields you leave out keep their current values.
Request
PATCH /manufacturing/v1/sites/patch
Content-Type: application/json
{
"properties": {
"code": "PLANT-NORTH",
"name": "North production plant"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
properties |
object | yes | Fields included in the partial update. |
properties.code |
string | yes | Business code of the site to update. |
properties.name |
string | no | New name of the site. |
Retrieve a site
GET /manufacturing/v1/sites/select
Returns the site identified by its business code. If no site has this code, the response is empty.
Request
GET /manufacturing/v1/sites/select?id=PLANT-NORTH
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the site to retrieve. |
Example response
{
"code": "PLANT-NORTH",
"name": "North plant"
}
List sites
GET /manufacturing/v1/sites/query
Returns sites matching the supplied filters.
Request
GET /manufacturing/v1/sites/query?codes=PLANT-NORTH&names=North%20plant
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
codes |
string or array of strings | no | Limits results to sites with the specified business codes. |
names |
string or array of strings | no | Limits results to sites with the specified names. Upper and lower case are not distinguished. |
Example response
[
{
"code": "PLANT-NORTH",
"name": "North plant"
}
]
Delete a site
DELETE /manufacturing/v1/sites/delete
Deletes the site identified by its business code. If no site has this code, nothing happens.
Request
DELETE /manufacturing/v1/sites/delete?id=PLANT-NORTH
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | yes | Business code of the site to delete. |