API Reference

Python Library

Blog

Serial

Documentation

Get Started

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).

Upload Files

serial default security

file-storage

Upload File Data

Let us know if you can't find the answer to your question

Introduction

Let's walk through the serial setup steps

Getting Started

Let us configure your parts & data in serial

1. Configure Serial

Let's deploy serial to your production line and start collecting data

2. Deploy Serial

Lets search a unique identifier on serial

3. Search Data

4. Adding Users

A deep-dive into all of the production template functionality

Production Template

A deep-dive into all of the process builder functionality

Process Builder

Here are some answers to common questions

General

Push test data to the cloud in 3 minutes or less!

Quickstart

Create or manage a component instance (serial number / lot code)

Component Instances

Create a process entry and add data to it

Process Entries

Gets all component instances matching query parameters

Get Component Instances

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

Get component instance links related to your query

Get Component Instance Links

Endpoint to create a link between two component instances

Create Component Instance Link

Endpoint to remove links between two component instances.

Delete Component Instance Link

Returns all work orders, in order of most recently updated

List all work orders

Create a work order

Request approval from a Serial user. Work order must be in the `DRAFT` or `REVIEW` state

Add Approver

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 Attachment

Add Comment

Approve or reject a work order. Work order must be in the `REVIEW` state

Approve or Reject Review

Remove approval request for a Serial user. Work order must be in the `DRAFT` state

Delete Approver

Delete Attachment

Delete a work order. Work order must be in the `DRAFT` state

Delete Work Order

Retreive a specific work order by it's id

Retrieve Work Order

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 Status

Update a work order's details and configuration. Work order must be in the `DRAFT` state

Update Work Order

Get Processes

Create a new, unsubmitted process entry. Returns the newly created process entry.

Create Process Entry

Get Process Entries

Endpoint for adding parametric & file data to process entries.

Add Process Data

Update Process Entry

Get Files

Get Datasets

Endpoint for creating datasets (also referred to as data keys).

Create Dataset

Update Dataset

Delete Dataset

Get Components

Create New Component

Create Component Link

Create a new property for a given component

Create New Component Property

Get the values of properties for a component instance

Get Component Instance Properties

Get the names and types of properties for a component

Get Component Properties

Update Component Instance Properties

Get Fields

Get Part Numbers

Create Part Number

This endpoint is responsible for uploading process data to the server. It accepts multipart form data as input, which includes a JSON payload named 'serial\_payload' and optionally images and files. The 'serial\_payload' consists of information about the identifier, station ID, links, parameters, images, files, and the pass/fail status of the process. Images and files are attached to the payload with their respective file names and binary data. The server's response is a 'requests.Response' object.

Upload Process Data

This endpoint is used for initializing a serial number or lot code inside of Serial. It expects a JSON payload that includes the identifier, component and part_number of the object to be initialized. The API key for authentication is sent in the headers. The server's response is a requests.Response object.

Create Serial Number

This endpoint checks if the server is active and if the station ID is valid. It expects a JSON payload containing the station ID. The API key for authentication is sent in the headers. The server's response is a requests.Response object indicating the success or failure of the connection check.

Component Instances

Work Orders

Processes

Storage

Datasets

Components

Properties

Fields

Part Numbers

Legacy API

Upload Files

Authorizations

Body

Response