65 lines
1.5 KiB
Markdown
65 lines
1.5 KiB
Markdown
---
|
|
name: devices-routes
|
|
description: Handle 5 OpenAPI operation(s) under /v2/devices for the devices route group.
|
|
---
|
|
|
|
# devices API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /v2/devices for the devices route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_devices
|
|
|
|
- Operation ID: `list_devices`
|
|
- Route: `GET /v2/devices`
|
|
- Mode: READ
|
|
- Summary: ListDevices
|
|
- Parameters:
|
|
- `cursor` in `query`
|
|
- `sort_order` in `query`
|
|
- `limit` in `query`
|
|
- `location_id` in `query`
|
|
|
|
### list_device_codes
|
|
|
|
- Operation ID: `list_device_codes`
|
|
- Route: `GET /v2/devices/codes`
|
|
- Mode: READ
|
|
- Summary: ListDeviceCodes
|
|
- Parameters:
|
|
- `cursor` in `query`
|
|
- `location_id` in `query`
|
|
- `product_type` in `query`
|
|
- `status` in `query`
|
|
|
|
### create_device_code
|
|
|
|
- Operation ID: `create_device_code`
|
|
- Route: `POST /v2/devices/codes`
|
|
- Mode: WRITE
|
|
- Summary: CreateDeviceCode
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_device_code
|
|
|
|
- Operation ID: `get_device_code`
|
|
- Route: `GET /v2/devices/codes/{id}`
|
|
- Mode: READ
|
|
- Summary: GetDeviceCode
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### get_device
|
|
|
|
- Operation ID: `get_device`
|
|
- Route: `GET /v2/devices/{device_id}`
|
|
- Mode: READ
|
|
- Summary: GetDevice
|
|
- Parameters:
|
|
- `device_id` in `path` required
|