The Workstation object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

workstation_name string required
description string
hour_rate number
holiday_list string
production_capacity integer

Default: 1

workstation_type string
plant_floor string
status string
on_status_image string
off_status_image string
warehouse string
total_working_hours number
disabled boolean

Default: false

The Workstation object 
{
  "id": "workstation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_name": "workstation_name_example",
  "description": "description_example",
  "hour_rate": 0,
  "holiday_list": "holiday_list_example",
  "production_capacity": 1,
  "workstation_type": "workstation_type_example",
  "plant_floor": "plant_floor_example",
  "status": "draft",
  "on_status_image": "on_status_image_example",
  "off_status_image": "off_status_image_example",
  "warehouse": "warehouse_example",
  "total_working_hours": 0,
  "disabled": false
}
GET /api/manufacturing/workstation/{id}

Retrieve a workstation

Retrieves the details of an existing workstation. Supply the unique workstation ID that was returned from a previous request.

Path parameters

id string required

The identifier of the workstation to retrieve.

Returns

Returns the workstation object if a valid identifier was provided.

GET /api/manufacturing/workstation/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation/workstation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "workstation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_name": "workstation_name_example",
  "description": "description_example",
  "hour_rate": 0,
  "holiday_list": "holiday_list_example",
  "production_capacity": 1,
  "workstation_type": "workstation_type_example",
  "plant_floor": "plant_floor_example",
  "status": "draft",
  "on_status_image": "on_status_image_example",
  "off_status_image": "off_status_image_example",
  "warehouse": "warehouse_example",
  "total_working_hours": 0,
  "disabled": false
}
GET /api/manufacturing/workstation

List all workstations

Returns a list of workstations. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of workstation objects.

GET /api/manufacturing/workstation 
curl https://api.overplane.dev/api/manufacturing/workstation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "workstation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "workstation_name": "workstation_name_example",
      "description": "description_example",
      "hour_rate": 0,
      "holiday_list": "holiday_list_example",
      "production_capacity": 1,
      "workstation_type": "workstation_type_example",
      "plant_floor": "plant_floor_example",
      "status": "draft",
      "on_status_image": "on_status_image_example",
      "off_status_image": "off_status_image_example",
      "warehouse": "warehouse_example",
      "total_working_hours": 0,
      "disabled": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/workstation

Create a workstation

Creates a new workstation object.

Body parameters

workstation_name string required
description string
hour_rate number
holiday_list string
production_capacity integer

Default: 1

workstation_type string
plant_floor string
status string
on_status_image string
off_status_image string
warehouse string
total_working_hours number
disabled boolean

Default: false

Returns

Returns the newly created workstation object if the call succeeded.

POST /api/manufacturing/workstation 
curl https://api.overplane.dev/api/manufacturing/workstation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"workstation_name":"workstation_name_example"}'
Response 
{
  "id": "workstation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_name": "workstation_name_example",
  "description": "description_example",
  "hour_rate": 0,
  "holiday_list": "holiday_list_example",
  "production_capacity": 1,
  "workstation_type": "workstation_type_example",
  "plant_floor": "plant_floor_example",
  "status": "draft",
  "on_status_image": "on_status_image_example",
  "off_status_image": "off_status_image_example",
  "warehouse": "warehouse_example",
  "total_working_hours": 0,
  "disabled": false
}
PATCH /api/manufacturing/workstation/{id}

Update a workstation

Updates the specified workstation by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the workstation to update.

Body parameters

workstation_name string
description string
hour_rate number
holiday_list string
production_capacity integer

Default: 1

workstation_type string
plant_floor string
status string
on_status_image string
off_status_image string
warehouse string
total_working_hours number
disabled boolean

Default: false

Returns

Returns the updated workstation object.

PATCH /api/manufacturing/workstation/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation/workstation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"workstation_name":"workstation_name_example","description":"description_example"}'
Response 
{
  "id": "workstation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_name": "workstation_name_example",
  "description": "description_example",
  "hour_rate": 0,
  "holiday_list": "holiday_list_example",
  "production_capacity": 1,
  "workstation_type": "workstation_type_example",
  "plant_floor": "plant_floor_example",
  "status": "draft",
  "on_status_image": "on_status_image_example",
  "off_status_image": "off_status_image_example",
  "warehouse": "warehouse_example",
  "total_working_hours": 0,
  "disabled": false
}
DELETE /api/manufacturing/workstation/{id}

Delete a workstation

Permanently deletes a workstation. This cannot be undone.

Path parameters

id string required

The identifier of the workstation to delete.

Returns

Returns a confirmation that the workstation has been deleted.

DELETE /api/manufacturing/workstation/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation/workstation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "workstation_abc123",
  "deleted": true
}

Line items

Child objects that belong to this workstation. These are accessed via the parent's ID.

Workstation Working Hour

Attributes

idx integer
workstation_id string required
start_time string required
end_time string required
enabled boolean
hours number

Endpoints

GET /api/manufacturing/workstation-working-hour?parent_id={id}
POST /api/manufacturing/workstation-working-hour
PATCH /api/manufacturing/workstation-working-hour/{id}
DELETE /api/manufacturing/workstation-working-hour/{id}
POST /api/manufacturing/workstation-working-hour/reorder
Workstation Working Hour object 
{
  "id": "workstation-working-hour_abc123",
  "idx": 1,
  "workstation_id": "workstation_id_example",
  "start_time": "start_time_example",
  "end_time": "end_time_example",
  "enabled": true,
  "hours": 0
}