The Workstation Cost object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
operating_cost number required
operating_component string required
The Workstation Cost object 
{
  "id": "workstation-cost_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "operating_cost": 0,
  "operating_component": "operating_component_example"
}
GET /api/manufacturing/workstation-cost?parent_id={id}

List workstation costs by parent

Returns all workstation costs belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of workstation cost objects belonging to the parent.

GET /api/manufacturing/workstation-cost?parent_id={id} 
curl https://api.overplane.dev/api/manufacturing/workstation-cost?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "workstation-cost_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "operating_cost": 0,
      "operating_component": "operating_component_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/workstation-cost

Create a workstation cost

Creates a new workstation cost object.

Body parameters

idx integer
parent_id string required
parent_type string required
operating_cost number required
operating_component string required

Returns

Returns the newly created workstation cost object if the call succeeded.

POST /api/manufacturing/workstation-cost 
curl https://api.overplane.dev/api/manufacturing/workstation-cost \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","operating_cost":0,"operating_component":"operating_component_example"}'
Response 
{
  "id": "workstation-cost_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "operating_cost": 0,
  "operating_component": "operating_component_example"
}
PATCH /api/manufacturing/workstation-cost/{id}

Update a workstation cost

Updates the specified workstation cost 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 cost to update.

Body parameters

idx integer
parent_id string
parent_type string
operating_cost number
operating_component string

Returns

Returns the updated workstation cost object.

PATCH /api/manufacturing/workstation-cost/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation-cost/workstation-cost_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "workstation-cost_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "operating_cost": 0,
  "operating_component": "operating_component_example"
}
DELETE /api/manufacturing/workstation-cost/{id}

Delete a workstation cost

Permanently deletes a workstation cost. This cannot be undone.

Path parameters

id string required

The identifier of the workstation cost to delete.

Returns

Returns a confirmation that the workstation cost has been deleted.

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

Reorder workstation costs

Updates the sort order of workstation costs within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/manufacturing/workstation-cost/reorder 
curl https://api.overplane.dev/api/manufacturing/workstation-cost/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "workstation-cost_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "operating_cost": 0,
  "operating_component": "operating_component_example"
}