131 lines
3.1 KiB
Markdown
131 lines
3.1 KiB
Markdown
---
|
|
name: flows-routes
|
|
description: Handle 9 OpenAPI operation(s) under /api/flows for the flows route group.
|
|
---
|
|
|
|
# flows API Routes
|
|
|
|
Handle 9 OpenAPI operation(s) under /api/flows for the flows 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_flows
|
|
|
|
- Operation ID: `get_flows`
|
|
- Route: `GET /api/flows`
|
|
- Mode: READ
|
|
- Summary: Get Flows
|
|
- Parameters:
|
|
- `fields[flow-action]` in `query`
|
|
- `fields[flow]` in `query`
|
|
- `fields[tag]` in `query`
|
|
- `filter` in `query`
|
|
- `include` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_flow
|
|
|
|
- Operation ID: `create_flow`
|
|
- Route: `POST /api/flows`
|
|
- Mode: WRITE
|
|
- Summary: Create Flow
|
|
- Parameters:
|
|
- `additional-fields[flow]` in `query`
|
|
- `fields[flow]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_flow
|
|
|
|
- Operation ID: `get_flow`
|
|
- Route: `GET /api/flows/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Flow
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[flow]` in `query`
|
|
- `fields[flow-action]` in `query`
|
|
- `fields[flow]` in `query`
|
|
- `fields[tag]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_flow
|
|
|
|
- Operation ID: `update_flow`
|
|
- Route: `PATCH /api/flows/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Flow Status
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_flow
|
|
|
|
- Operation ID: `delete_flow`
|
|
- Route: `DELETE /api/flows/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Flow
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_actions_for_flow
|
|
|
|
- Operation ID: `get_actions_for_flow`
|
|
- Route: `GET /api/flows/{id}/flow-actions`
|
|
- Mode: READ
|
|
- Summary: Get Actions for Flow
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow-action]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_action_ids_for_flow
|
|
|
|
- Operation ID: `get_action_ids_for_flow`
|
|
- Route: `GET /api/flows/{id}/relationships/flow-actions`
|
|
- Mode: READ
|
|
- Summary: Get Action IDs for Flow
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_tags_for_flow
|
|
|
|
- Operation ID: `get_tags_for_flow`
|
|
- Route: `GET /api/flows/{id}/tags`
|
|
- Mode: READ
|
|
- Summary: Get Tags for Flow
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[tag]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_tag_ids_for_flow
|
|
|
|
- Operation ID: `get_tag_ids_for_flow`
|
|
- Route: `GET /api/flows/{id}/relationships/tags`
|
|
- Mode: READ
|
|
- Summary: Get Tag IDs for Flow
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|