101 lines
2.7 KiB
Markdown
101 lines
2.7 KiB
Markdown
---
|
|
name: flow-actions-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/flow-actions/{id} for the flow actions route group.
|
|
---
|
|
|
|
# flow actions API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/flow-actions/{id} for the flow actions 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_flow_action
|
|
|
|
- Operation ID: `get_flow_action`
|
|
- Route: `GET /api/flow-actions/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow-action]` in `query`
|
|
- `fields[flow-message]` in `query`
|
|
- `fields[flow]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_flow_action
|
|
|
|
- Operation ID: `update_flow_action`
|
|
- Route: `PATCH /api/flow-actions/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow-action]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_flow_action
|
|
|
|
- Operation ID: `delete_flow_action`
|
|
- Route: `DELETE /api/flow-actions/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_flow_for_flow_action
|
|
|
|
- Operation ID: `get_flow_for_flow_action`
|
|
- Route: `GET /api/flow-actions/{id}/flow`
|
|
- Mode: READ
|
|
- Summary: Get Flow for Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_flow_id_for_flow_action
|
|
|
|
- Operation ID: `get_flow_id_for_flow_action`
|
|
- Route: `GET /api/flow-actions/{id}/relationships/flow`
|
|
- Mode: READ
|
|
- Summary: Get Flow ID for Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_flow_action_messages
|
|
|
|
- Operation ID: `get_flow_action_messages`
|
|
- Route: `GET /api/flow-actions/{id}/flow-messages`
|
|
- Mode: READ
|
|
- Summary: Get Messages For Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow-message]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_message_ids_for_flow_action
|
|
|
|
- Operation ID: `get_message_ids_for_flow_action`
|
|
- Route: `GET /api/flow-actions/{id}/relationships/flow-messages`
|
|
- Mode: READ
|
|
- Summary: Get Message IDs for Flow Action
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|