71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
---
|
|
name: schedules-routes
|
|
description: Handle 6 OpenAPI operation(s) under /v2/schedules for the schedules route group.
|
|
---
|
|
|
|
# schedules API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /v2/schedules for the schedules 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
|
|
|
|
### schedules_get
|
|
|
|
- Operation ID: `schedules_get`
|
|
- Route: `GET /v2/schedules`
|
|
- Mode: READ
|
|
- Summary: Get list of schedules
|
|
- Parameters:
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `desc` in `query`
|
|
|
|
### schedules_post
|
|
|
|
- Operation ID: `schedules_post`
|
|
- Route: `POST /v2/schedules`
|
|
- Mode: WRITE
|
|
- Summary: Create schedule
|
|
- Body: JSON request body accepted.
|
|
|
|
### schedule_get
|
|
|
|
- Operation ID: `schedule_get`
|
|
- Route: `GET /v2/schedules/{scheduleId}`
|
|
- Mode: READ
|
|
- Summary: Get schedule
|
|
- Parameters:
|
|
- `scheduleId` in `path` required
|
|
|
|
### schedule_put
|
|
|
|
- Operation ID: `schedule_put`
|
|
- Route: `PUT /v2/schedules/{scheduleId}`
|
|
- Mode: WRITE
|
|
- Summary: Update schedule
|
|
- Parameters:
|
|
- `scheduleId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### schedule_delete
|
|
|
|
- Operation ID: `schedule_delete`
|
|
- Route: `DELETE /v2/schedules/{scheduleId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete schedule
|
|
- Parameters:
|
|
- `scheduleId` in `path` required
|
|
|
|
### schedule_log_get
|
|
|
|
- Operation ID: `schedule_log_get`
|
|
- Route: `GET /v2/schedules/{scheduleId}/log`
|
|
- Mode: READ
|
|
- Summary: Get schedule log
|
|
- Parameters:
|
|
- `scheduleId` in `path` required
|