71 lines
2.0 KiB
Markdown
71 lines
2.0 KiB
Markdown
---
|
|
name: flow-messages-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/flow-messages/{id} for the flow messages route group.
|
|
---
|
|
|
|
# flow messages API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/flow-messages/{id} for the flow messages 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_message
|
|
|
|
- Operation ID: `get_flow_message`
|
|
- Route: `GET /api/flow-messages/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Flow Message
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow-action]` in `query`
|
|
- `fields[flow-message]` in `query`
|
|
- `fields[template]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_action_for_flow_message
|
|
|
|
- Operation ID: `get_action_for_flow_message`
|
|
- Route: `GET /api/flow-messages/{id}/flow-action`
|
|
- Mode: READ
|
|
- Summary: Get Action for Flow Message
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow-action]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_action_id_for_flow_message
|
|
|
|
- Operation ID: `get_action_id_for_flow_message`
|
|
- Route: `GET /api/flow-messages/{id}/relationships/flow-action`
|
|
- Mode: READ
|
|
- Summary: Get Action ID for Flow Message
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_template_for_flow_message
|
|
|
|
- Operation ID: `get_template_for_flow_message`
|
|
- Route: `GET /api/flow-messages/{id}/template`
|
|
- Mode: READ
|
|
- Summary: Get Template for Flow Message
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[template]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_template_id_for_flow_message
|
|
|
|
- Operation ID: `get_template_id_for_flow_message`
|
|
- Route: `GET /api/flow-messages/{id}/relationships/template`
|
|
- Mode: READ
|
|
- Summary: Get Template ID for Flow Message
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|