Skip to main content
PUT
/
components
/
instances
Create Component Instance
curl --request PUT \
  --url https://api.serial.io/components/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "component_id": "<string>",
  "part_number_id": "<string>",
  "work_order_id": "<string>",
  "station_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
'
{
  "identifier": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "WIP",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "part_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_archived": true,
  "work_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "latitude": 123,
  "longitude": 123
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Headers

​
Validation-Only
boolean

Set this header to true if you want to validate the input and check the expected response without actually performing the action.

Body

application/json
​
identifier
string
required

Serial number, lot code or component instance UUID

​
component_id
string
required
​
part_number_id
string
​
work_order_id
string
​
station_id
string
​
created_at
string<date-time>

Available to override the created_at timestamp in the database

Response

OK

​
identifier
string
required
​
id
string<uuid>
​
component_id
string<uuid>
​
created_at
string<date-time>
​
status
enum<string>
Available options:
WIP,
PLANNED,
DEFECTIVE,
COMPLETE
​
last_updated_at
string<date-time>
​
completed_at
string<date-time>
​
part_number_id
string<uuid>
​
is_archived
boolean
​
work_order_id
string<uuid>
​
latitude
number<float>
​
longitude
number<float>