Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.serial.okos.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Create

Use ComponentInstances.create() to instantiate a new serial number or lot code. 
my_component_instance = serial.ComponentInstances.create(
    identifier="ABC-123", 
    component_name="Component Name"
)

​
identifier
string
required
The serial number or lot code of the component instance
​
component_name
string
required
The name of the component that you want to create an instance of

​
Get

Use ComponentInstances.get() to get an existing instance of a serial number or lot code. 
my_component_instance = serial.ComponentInstances.get(
    identifier="ABC-123", 
)

​
identifier
string
required
The serial number or lot code of the component instance

​
List

Use ComponentInstances.list() to list all component instances matching the query parameters 
defective_components = serial.ComponentInstances.list(
    {
        "status": "DEFECTIVE"
    }
)

​
component_type
string
Component’s Type (either SN or LOT)
​
status
string
Component’s Status (WIP, PLANNED, DEFECTIVE, COMPLETE)
​
part_number_id
string
Components associated to particular work order
​
work_order_id
string
Components associated with a specific part number