# Serial ## Docs - [Create Component Instance](https://docs.serial.okos.com/api-reference/component-instances/create-component-instance.md): Creates a new instance of the component with a specified identifier (serial number, lot code or component UUID). Use the `validation-only` header to check the predicted result before actually instantiating a component instance. - [Create Component Instance Link](https://docs.serial.okos.com/api-reference/component-instances/create-component-instance-link.md): Endpoint to create a link between two component instances - [Delete Component Instance Link](https://docs.serial.okos.com/api-reference/component-instances/delete-component-instance-link.md): Endpoint to remove links between two component instances. - [Get Component Instance Links](https://docs.serial.okos.com/api-reference/component-instances/get-component-instance-links.md): Get component instance links related to your query - [Get Component Instances](https://docs.serial.okos.com/api-reference/component-instances/get-component-instances.md): Gets all component instances matching query parameters - [Create Component Link](https://docs.serial.okos.com/api-reference/components/create-component-link.md): Create a link between two components - [Create New Component](https://docs.serial.okos.com/api-reference/components/create-new-component.md): Create new Component - [Get Components](https://docs.serial.okos.com/api-reference/components/get-components.md): Endpoint for getting components - [Create Dataset](https://docs.serial.okos.com/api-reference/datasets/create-dataset.md): Endpoint for creating datasets (also referred to as data keys). - [Delete Dataset](https://docs.serial.okos.com/api-reference/datasets/delete-dataset.md) - [Get Datasets](https://docs.serial.okos.com/api-reference/datasets/get-datasets.md): Endpoint for getting datasets - [Update Dataset](https://docs.serial.okos.com/api-reference/datasets/update-dataset.md): Endpoint to update datasets - [Get Fields](https://docs.serial.okos.com/api-reference/fields/get-fields.md): Get Fields and their metadata - [Create Part Number](https://docs.serial.okos.com/api-reference/part-numbers/create-part-number.md): Endpoint for creating new part numbers - [Get Part Numbers](https://docs.serial.okos.com/api-reference/part-numbers/get-part-numbers.md): Endpoint for getting part numbers - [Add Process Data](https://docs.serial.okos.com/api-reference/processes/add-process-data.md): Endpoint for adding parametric & file data to process entries. - [Create Process Entry](https://docs.serial.okos.com/api-reference/processes/create-process-entry.md): Create a new, unsubmitted process entry. Returns the newly created process entry. - [Get Process Entries](https://docs.serial.okos.com/api-reference/processes/get-process-entries.md): Endpoint for getting process entries - [Get Processes](https://docs.serial.okos.com/api-reference/processes/get-processes.md): Get processes for your company - [Update Process Entry](https://docs.serial.okos.com/api-reference/processes/update-process-entry.md): Complete Process Entry - [Create New Component Property](https://docs.serial.okos.com/api-reference/properties/create-new-component-property.md): Create a new property for a given component - [Get Component Instance Properties](https://docs.serial.okos.com/api-reference/properties/get-component-instance-properties.md): Get the values of properties for a component instance - [Get Component Properties](https://docs.serial.okos.com/api-reference/properties/get-component-properties.md): Get the names and types of properties for a component - [Update Component Instance Properties](https://docs.serial.okos.com/api-reference/properties/update-component-instance-property.md): Add data to property - [Get Files](https://docs.serial.okos.com/api-reference/storage/get-files.md): Get files - [Upload Files](https://docs.serial.okos.com/api-reference/storage/upload-files.md): Endpoint for direct uploading of files to Serial's backend (includes both images & files). Be sure to include the file metadata if you want your file properly categorized (name, binary, & mimetype). - [Add Approver](https://docs.serial.okos.com/api-reference/work-orders/add-approver.md): Request approval from a Serial user. Work order must be in the `DRAFT` or `REVIEW` state - [Add Attachment](https://docs.serial.okos.com/api-reference/work-orders/add-attachment.md): Add an attachment to the work order. Work order must be in the `DRAFT` state. One attachment can be added per request. Attachments can be `IMAGE`, `FILE`, or `TEXT` (corresponding to the same data types in Serial). - [Add Comment](https://docs.serial.okos.com/api-reference/work-orders/add-comment.md): Add a comment to the activity log - [Approve or Reject Review](https://docs.serial.okos.com/api-reference/work-orders/approve-or-reject-review.md): Approve or reject a work order. Work order must be in the `REVIEW` state - [Create a work order](https://docs.serial.okos.com/api-reference/work-orders/create-a-work-order.md): Create a new (`DRAFT`) work order - [Delete Approver](https://docs.serial.okos.com/api-reference/work-orders/delete-approver.md): Remove approval request for a Serial user. Work order must be in the `DRAFT` state - [Delete Attachment](https://docs.serial.okos.com/api-reference/work-orders/delete-attachment.md): Remove approval request for a Serial user. Work order must be in the `DRAFT` state - [Delete Work Order](https://docs.serial.okos.com/api-reference/work-orders/delete-work-order.md): Delete a work order. Work order must be in the `DRAFT` state - [List all work orders](https://docs.serial.okos.com/api-reference/work-orders/list-all-work-orders.md): Returns all work orders, in order of most recently updated - [Retrieve Work Order](https://docs.serial.okos.com/api-reference/work-orders/retrieve-work-order.md): Retreive a specific work order by it's id - [Update Status](https://docs.serial.okos.com/api-reference/work-orders/update-status.md): Promote or demote the work order status. For example, after a work order has been drafted it can be promoted to review, the released for production - [Update Work Order](https://docs.serial.okos.com/api-reference/work-orders/update-work-order.md): Update a work order's details and configuration. Work order must be in the `DRAFT` state - [Context](https://docs.serial.okos.com/developer/frontend/context.md): Context is a feature of Serial that allows for state management at the feature level. - [Frontend Primitives](https://docs.serial.okos.com/developer/frontend/frontend-primitives.md): An overview of reusable UI components and how to view them in the Serial application - [Label Printing](https://docs.serial.okos.com/developer/frontend/labels.md): Explore the implementation of label printing functionality in Serial, including support for Dymo and Zebra printers. - [Local Realtime Database](https://docs.serial.okos.com/developer/frontend/local-realtime-db.md): Serial implements a local realtime database system to provide efficient, live-updating data across the application - [Measures](https://docs.serial.okos.com/developer/frontend/measures.md): The measures feature. A building block for the grid builder and graph builder - [Production App](https://docs.serial.okos.com/developer/frontend/production-app.md): An overview of how data is uploaded by the production app - [Architecture](https://docs.serial.okos.com/developer/general/architecture.md): An overview of the architecture of Serial - [CI/CD](https://docs.serial.okos.com/developer/general/ci-cd.md): An overview of the continuous integration & continuous deployment processes in Serial - [Environments](https://docs.serial.okos.com/developer/general/environments.md): An overview of the different Serial environments and environment variables - [Getting Started](https://docs.serial.okos.com/developer/general/getting-started.md): How to get started developing with Serial - [Monorepo](https://docs.serial.okos.com/developer/general/monorepo.md): An overview of the Serial monorepo - [Tech Dept](https://docs.serial.okos.com/developer/general/tech-dept.md): Like any large codebase, Serial has a few tech debt items that are important would be nice to fix eventually. This document is a place to collect those ideas and thoughts. - [Database Functions](https://docs.serial.okos.com/developer/supabase/database-functions.md): A comprehensive summary of database functions used in the Serial application, covering data management, calculations, and insights. - [Database Triggers](https://docs.serial.okos.com/developer/supabase/database-triggers.md): An overview of the triggers used in the Serial database system - [Alerts](https://docs.serial.okos.com/developer/supabase/tables/alerts.md): An in-depth look at the structure and purpose of the `alerts` table in the Serial database - [Checkboxes](https://docs.serial.okos.com/developer/supabase/tables/checkboxes.md): An in-depth look at the structure and purpose of the `checkboxes` table in the Serial database - [Companies](https://docs.serial.okos.com/developer/supabase/tables/companies.md): An in-depth look at the structure and purpose of the `companies` table in the Serial database - [Component Links](https://docs.serial.okos.com/developer/supabase/tables/component_links.md): An in-depth look at the structure and purpose of the `component_links` table in the Serial database - [Component Process Links](https://docs.serial.okos.com/developer/supabase/tables/component_process_links.md): An in-depth look at the structure and purpose of the `component_process_links` table in the Serial database - [Components](https://docs.serial.okos.com/developer/supabase/tables/components.md): An in-depth look at the structure and purpose of the `components` table in the Serial database - [Datasets](https://docs.serial.okos.com/developer/supabase/tables/datasets.md): An in-depth look at the structure and purpose of the `datasets` table in the Serial database - [Datetime Data](https://docs.serial.okos.com/developer/supabase/tables/datetime_data.md): An in-depth look at the structure and purpose of the `datetime_data` table in the Serial database - [Fields](https://docs.serial.okos.com/developer/supabase/tables/fields.md): An in-depth look at the structure and purpose of the `fields` table in the Serial database - [Files](https://docs.serial.okos.com/developer/supabase/tables/files.md): An in-depth look at the structure and purpose of the `files` table in the Serial database - [Filter Conditions](https://docs.serial.okos.com/developer/supabase/tables/filter_conditions.md): An in-depth look at the structure and purpose of the `filter_conditions` table in the Serial database - [Images](https://docs.serial.okos.com/developer/supabase/tables/images.md): An in-depth look at the structure and purpose of the `images` table in the Serial database - [Label Elements](https://docs.serial.okos.com/developer/supabase/tables/label_elements.md): An in-depth look at the structure and purpose of the `label_elements` table in the Serial database - [Label Formats](https://docs.serial.okos.com/developer/supabase/tables/label_formats.md): An in-depth look at the structure and purpose of the `label_formats` table in the Serial database - [Log File Schema Dataset Links](https://docs.serial.okos.com/developer/supabase/tables/log_file_schema_dataset_links.md): An in-depth look at the structure and purpose of the `log_file_schema_dataset_links` table in the Serial database - [Log File Schemas](https://docs.serial.okos.com/developer/supabase/tables/log_file_schemas.md): An in-depth look at the structure and purpose of the `log_file_schemas` table in the Serial database - [Operators](https://docs.serial.okos.com/developer/supabase/tables/operators.md): An in-depth look at the structure and purpose of the `operators` table in the Serial database - [Parametric Qualitative](https://docs.serial.okos.com/developer/supabase/tables/parametric_qualitative.md): An in-depth look at the structure and purpose of the `parametric_qualitative` table in the Serial database - [ParametricQuantitative](https://docs.serial.okos.com/developer/supabase/tables/parametric_quantitative.md): An in-depth look at the structure and purpose of the `parametric_quantitative` table in the Serial database - [Part Numbers](https://docs.serial.okos.com/developer/supabase/tables/part_numbers.md): An in-depth look at the structure and purpose of the `part_numbers` table in the Serial database - [Process Entries](https://docs.serial.okos.com/developer/supabase/tables/process_entries.md): An in-depth look at the structure and purpose of the `process_entries` table in the Serial database - [Process Entries](https://docs.serial.okos.com/developer/supabase/tables/process_steps.md): An in-depth look at the structure and purpose of the `process_steps` table in the Serial database - [Processes](https://docs.serial.okos.com/developer/supabase/tables/processes.md): An in-depth look at the structure and purpose of the `processes` table in the Serial database - [Report Templates](https://docs.serial.okos.com/developer/supabase/tables/report_templates.md): An in-depth look at the structure and purpose of the `report_templates` table in the Serial database - [Station Process Links](https://docs.serial.okos.com/developer/supabase/tables/station_process_links.md): An in-depth look at the structure and purpose of the `station_process_links` table in the Serial database - [Stations](https://docs.serial.okos.com/developer/supabase/tables/stations.md): An in-depth look at the structure and purpose of the `stations` table in the Serial database - [Unique Identifier Activity Log](https://docs.serial.okos.com/developer/supabase/tables/unique_identifier_activity_log.md): An in-depth look at the structure and purpose of the `unique_identifier_activity_log` table in the Serial database - [Unique Identifier Links](https://docs.serial.okos.com/developer/supabase/tables/unique_identifier_links.md): An in-depth look at the structure and purpose of the `unique_identifier_links` table in the Serial database - [Unique Identifiers](https://docs.serial.okos.com/developer/supabase/tables/unique_identifiers.md): An in-depth look at the structure and purpose of the `unique_identifiers` table in the Serial database - [Users](https://docs.serial.okos.com/developer/supabase/tables/users.md): An in-depth look at the structure and purpose of the `users` table in the Serial database - [Versions](https://docs.serial.okos.com/developer/supabase/tables/versions.md): An in-depth look at the structure and purpose of the `versions` table in the Serial database - [Webhooks](https://docs.serial.okos.com/developer/supabase/tables/webhooks.md): An in-depth look at the structure and purpose of the `webhooks` table in the Serial database - [Work Instruction Blocks](https://docs.serial.okos.com/developer/supabase/tables/work_instruction_blocks.md): An in-depth look at the structure and purpose of the `work_instruction_blocks` table in the Serial database - [Work Orders](https://docs.serial.okos.com/developer/supabase/tables/work_orders.md): An in-depth look at the structure and purpose of the `work_orders` table in the Serial database - [API Authentication](https://docs.serial.okos.com/developer/zuplo/api-auth.md): An in-depth look at how Serial manages API authentication using Zuplo, supporting both JWT and API key methods - [API Structure](https://docs.serial.okos.com/developer/zuplo/api-structure.md): Overview of the structure of the Serial API. - [Component Instances](https://docs.serial.okos.com/python/component-instance.md): Create or manage a component instance (serial number / lot code) - [Process Entries](https://docs.serial.okos.com/python/process-entry.md): Create a process entry and add data to it - [Quickstart](https://docs.serial.okos.com/python/quickstart.md): Push test data to the cloud in 3 minutes or less! ## OpenAPI Specs - [openapi](https://docs.serial.okos.com/api-reference/openapi.json) - [serial](https://docs.serial.okos.com/serial.json)