Skip to main content
PATCH
/
work-order
/
{id}
Update Work Order
curl --request PATCH \
  --url https://api.serial.io/work-order/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "KS1 Drone - CalFire Order",
  "description": "Urgent order for upcoming summer fire season",
  "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b",
  "part_number_id": "7dec118a-512b-42ec-bf53-7cec3d14d5c7",
  "phase": "string",
  "quantity": 10,
  "assignee_user_id": "e942d24d-8cee-4fa2-bf68-164509e32e2f",
  "deadline": "2019-08-24T14:15:22Z",
  "updated_by_user_id": "1b287364-14ff-4b72-8953-b40399093a6f"
}
'
{
  "id": "<string>",
  "wo_number": 1,
  "name": "<string>",
  "description": "<string>",
  "component_id": "<string>",
  "part_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "DRAFT",
  "phase": "<string>",
  "quantity": 123,
  "approvals": {
    "[approver_user_id]": {
      "approver_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requested_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requested_at": "2023-11-07T05:31:56Z",
      "status": "APPROVED",
      "last_updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deadline": "2023-11-07T05:31:56Z",
  "activity_log": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message": "<string>",
      "added_at": "2023-11-07T05:31:56Z",
      "added_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "CREATED",
      "data": "<string>"
    }
  ],
  "last_edited_at": "2023-11-07T05:31:56Z",
  "attachments": [
    {
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "file_name": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "added_at": "2023-11-07T05:31:56Z",
      "added_by_user_id": "<string>",
      "is_deleted": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Path Parameters

​
id
string
required

The work order UUID (work_order.id) or work order number (work_order.wo_number). Both will map to the same work order

Body

application/json

Request body for creating or updating a work order

​
name
string
required
​
component_id
string<uuid>
required
​
quantity
integer
required
Required range: x >= 1
​
updated_by_user_id
string<uuid>
required
​
description
string
​
part_number_id
string<uuid>
​
phase
string
​
assignee_user_id
string<uuid>
​
deadline
string<date-time>

Response

200 - application/json

OK

Work Order Data

​
id
string
​
wo_number
integer
Required range: x >= 0
​
name
string
​
description
string | null
​
component_id
string
​
part_number_id
string<uuid> | null
​
created_at
string<date-time>
​
created_by_user_id
string<uuid>
​
status
enum<string>
default:DRAFT
Available options:
DRAFT,
REVIEW,
PRODUCTION,
COMPLETE,
CANCELED,
ARCHIVED
​
phase
string
​
quantity
integer
​
approvals
object

Approvals object will have one key value pair for every approver

​
assignee_user_id
string<uuid> | null
​
deadline
string<date-time> | null
​
activity_log
object[]
​
last_edited_at
string<date-time> | null
​
attachments
object[]

Multiple datasets can be added to the attachments object