The Workstation Operating Component 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.

component_name string required
The Workstation Operating Component object 
{
  "id": "workstation-operating-component_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "component_name": "component_name_example"
}
GET /api/manufacturing/workstation-operating-component/{id}

Retrieve a workstation operating component

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

Path parameters

id string required

The identifier of the workstation operating component to retrieve.

Returns

Returns the workstation operating component object if a valid identifier was provided.

GET /api/manufacturing/workstation-operating-component/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation-operating-component/workstation-operating-component_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "workstation-operating-component_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "component_name": "component_name_example"
}
GET /api/manufacturing/workstation-operating-component

List all workstation operating components

Returns a list of workstation operating components. 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 operating component objects.

GET /api/manufacturing/workstation-operating-component 
curl https://api.overplane.dev/api/manufacturing/workstation-operating-component \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "workstation-operating-component_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "component_name": "component_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/workstation-operating-component

Create a workstation operating component

Creates a new workstation operating component object.

Body parameters

component_name string required

Returns

Returns the newly created workstation operating component object if the call succeeded.

POST /api/manufacturing/workstation-operating-component 
curl https://api.overplane.dev/api/manufacturing/workstation-operating-component \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"component_name":"component_name_example"}'
Response 
{
  "id": "workstation-operating-component_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "component_name": "component_name_example"
}
PATCH /api/manufacturing/workstation-operating-component/{id}

Update a workstation operating component

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

Body parameters

component_name string

Returns

Returns the updated workstation operating component object.

PATCH /api/manufacturing/workstation-operating-component/{id} 
curl https://api.overplane.dev/api/manufacturing/workstation-operating-component/workstation-operating-component_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"component_name":"component_name_example"}'
Response 
{
  "id": "workstation-operating-component_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "component_name": "component_name_example"
}
DELETE /api/manufacturing/workstation-operating-component/{id}

Delete a workstation operating component

Permanently deletes a workstation operating component. This cannot be undone.

Path parameters

id string required

The identifier of the workstation operating component to delete.

Returns

Returns a confirmation that the workstation operating component has been deleted.

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

Line items

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

Workstation Operating Component Account

Attributes

idx integer
workstation_operating_component_id string required
company string required
expense_account string

Endpoints

GET /api/manufacturing/workstation-operating-component-account?parent_id={id}
POST /api/manufacturing/workstation-operating-component-account
PATCH /api/manufacturing/workstation-operating-component-account/{id}
DELETE /api/manufacturing/workstation-operating-component-account/{id}
POST /api/manufacturing/workstation-operating-component-account/reorder
Workstation Operating Component Account object 
{
  "id": "workstation-operating-component-account_abc123",
  "idx": 1,
  "workstation_operating_component_id": "workstation_operating_component_id_example",
  "company": "Example Corp",
  "expense_account": "expense_account_example"
}