3.1 KiB
3.1 KiB
name, description
| name | description |
|---|---|
| flows-routes | 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]inqueryfields[flow]inqueryfields[tag]inqueryfilterinqueryincludeinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
create_flow
- Operation ID:
create_flow - Route:
POST /api/flows - Mode: WRITE
- Summary: Create Flow
- Parameters:
additional-fields[flow]inqueryfields[flow]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
get_flow
- Operation ID:
get_flow - Route:
GET /api/flows/{id} - Mode: READ
- Summary: Get Flow
- Parameters:
idinpathrequiredadditional-fields[flow]inqueryfields[flow-action]inqueryfields[flow]inqueryfields[tag]inqueryincludeinqueryrevisioninheaderrequired
update_flow
- Operation ID:
update_flow - Route:
PATCH /api/flows/{id} - Mode: WRITE
- Summary: Update Flow Status
- Parameters:
idinpathrequiredfields[flow]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
delete_flow
- Operation ID:
delete_flow - Route:
DELETE /api/flows/{id} - Mode: WRITE
- Summary: Delete Flow
- Parameters:
idinpathrequiredrevisioninheaderrequired
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:
idinpathrequiredfields[flow-action]inqueryfilterinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
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:
idinpathrequiredfilterinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
get_tags_for_flow
- Operation ID:
get_tags_for_flow - Route:
GET /api/flows/{id}/tags - Mode: READ
- Summary: Get Tags for Flow
- Parameters:
idinpathrequiredfields[tag]inqueryrevisioninheaderrequired
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:
idinpathrequiredrevisioninheaderrequired