90 lines
2.1 KiB
Markdown
90 lines
2.1 KiB
Markdown
---
|
|
name: forms-routes
|
|
description: Handle 6 OpenAPI operation(s) under /api/forms for the forms route group.
|
|
---
|
|
|
|
# forms API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /api/forms for the forms 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
|
|
|
|
### get_forms
|
|
|
|
- Operation ID: `get_forms`
|
|
- Route: `GET /api/forms`
|
|
- Mode: READ
|
|
- Summary: Get Forms
|
|
- Parameters:
|
|
- `fields[form]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_form
|
|
|
|
- Operation ID: `create_form`
|
|
- Route: `POST /api/forms`
|
|
- Mode: WRITE
|
|
- Summary: Create Form
|
|
- Parameters:
|
|
- `fields[form]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_form
|
|
|
|
- Operation ID: `get_form`
|
|
- Route: `GET /api/forms/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Form
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[form]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### delete_form
|
|
|
|
- Operation ID: `delete_form`
|
|
- Route: `DELETE /api/forms/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Form
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_versions_for_form
|
|
|
|
- Operation ID: `get_versions_for_form`
|
|
- Route: `GET /api/forms/{id}/form-versions`
|
|
- Mode: READ
|
|
- Summary: Get Versions for Form
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[form-version]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_version_ids_for_form
|
|
|
|
- Operation ID: `get_version_ids_for_form`
|
|
- Route: `GET /api/forms/{id}/relationships/form-versions`
|
|
- Mode: READ
|
|
- Summary: Get Version IDs for Form
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|