The Workstation Type 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_type string required
hour_rate number
description string
The Workstation Type object 
{
  "id": "workstation-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_type": "workstation_type_example",
  "hour_rate": 0,
  "description": "description_example"
}
GET /api/manufacturing/workstation-type/{id}

Retrieve a workstation type

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

Path parameters

id string required

The identifier of the workstation type to retrieve.

Returns

Returns the workstation type object if a valid identifier was provided.

GET /api/manufacturing/workstation-type/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation-type/workstation-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "workstation-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_type": "workstation_type_example",
  "hour_rate": 0,
  "description": "description_example"
}
GET /api/manufacturing/workstation-type

List all workstation types

Returns a list of workstation types. 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 type objects.

GET /api/manufacturing/workstation-type 
curl https://api.overplane.dev/api/manufacturing/workstation-type \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "workstation-type_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "workstation_type": "workstation_type_example",
      "hour_rate": 0,
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/workstation-type

Create a workstation type

Creates a new workstation type object.

Body parameters

workstation_type string required
hour_rate number
description string

Returns

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

POST /api/manufacturing/workstation-type 
curl https://api.overplane.dev/api/manufacturing/workstation-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"workstation_type":"workstation_type_example"}'
Response 
{
  "id": "workstation-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_type": "workstation_type_example",
  "hour_rate": 0,
  "description": "description_example"
}
PATCH /api/manufacturing/workstation-type/{id}

Update a workstation type

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

Body parameters

workstation_type string
hour_rate number
description string

Returns

Returns the updated workstation type object.

PATCH /api/manufacturing/workstation-type/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation-type/workstation-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"workstation_type":"workstation_type_example","hour_rate":0}'
Response 
{
  "id": "workstation-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "workstation_type": "workstation_type_example",
  "hour_rate": 0,
  "description": "description_example"
}
DELETE /api/manufacturing/workstation-type/{id}

Delete a workstation type

Permanently deletes a workstation type. This cannot be undone.

Path parameters

id string required

The identifier of the workstation type to delete.

Returns

Returns a confirmation that the workstation type has been deleted.

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