Skip to content
WAKU Care Documentation

Create a new work order

POST
/workorders
curl --request POST \
  --url https://api.waku-robotics.com/v1/workorders \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "assignee_id": "example", "deployment_id": "example", "device_ids": [ "example" ], "template_id": "example", "title": "example", "workspace_id": "example" }'

Create a new work order

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Work Order

Media typeapplication/json
object
assignee_id

The ID of the user to which this work order should be assigned

string
deployment_id
required

The ID of the deployment in which the work order should be created

string
device_ids

The IDs of the devices this work order should be created for

Array<string>
template_id
required

The ID of the checklist template to use for this work order

string
title
required

The title of the work order

string
workspace_id
required

The ID of the workspace in which the work order should be created

string

Example generated

{
  "assignee_id": "example",
  "deployment_id": "example",
  "device_ids": [
    "example"
  ],
  "template_id": "example",
  "title": "example",
  "workspace_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
assignee_id
required
string
created_at
required
string
devices
Array<object>
object
id
required
string
name
required
string
reference
required
string
id
required
string
notes
required
string
planned_at
string
resolved_at
string
scheduled_at
string
skip_reason
required
string
started_at
string
status
required
string
tasks
Array<object>
object
created_at
required
string
description
required
string
device_id
required
string
device_name
required
string
device_reference
required
string
id
required
string
name
required
string
notes
required
string
parts
Array<object>
object
location_id
required
string
note
required
string
part_id
required
string
quantity
required
integer
usage
required
string
resolved_at
string
started_at
string
status
required
string
template
object
id
required
string
title
required
string
updated_at
required
string
work_order_id
required
string
title
required
string
updated_at
required
string
work_order_tags
Array<object>
object
id
required
string
name
required
string

Example generated

{
  "assignee_id": "example",
  "created_at": "example",
  "devices": [
    {
      "id": "example",
      "name": "example",
      "reference": "example"
    }
  ],
  "id": "example",
  "notes": "example",
  "planned_at": "example",
  "resolved_at": "example",
  "scheduled_at": "example",
  "skip_reason": "example",
  "started_at": "example",
  "status": "example",
  "tasks": [
    {
      "created_at": "example",
      "description": "example",
      "device_id": "example",
      "device_name": "example",
      "device_reference": "example",
      "id": "example",
      "name": "example",
      "notes": "example",
      "parts": [
        {
          "location_id": "example",
          "note": "example",
          "part_id": "example",
          "quantity": 1,
          "usage": "example"
        }
      ],
      "resolved_at": "example",
      "started_at": "example",
      "status": "example",
      "template": {
        "id": "example",
        "title": "example"
      },
      "updated_at": "example",
      "work_order_id": "example"
    }
  ],
  "title": "example",
  "updated_at": "example",
  "work_order_tags": [
    {
      "id": "example",
      "name": "example"
    }
  ]
}

default

Section titled “default”
Media typeapplication/json
object
code
integer
message
string

Example generated

{
  "code": 1,
  "message": "example"
}