96 lines
2.7 KiB
Markdown
96 lines
2.7 KiB
Markdown
---
|
|
name: mapped-metrics-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/mapped-metrics for the mapped metrics route group.
|
|
---
|
|
|
|
# mapped metrics API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/mapped-metrics for the mapped metrics 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_mapped_metrics
|
|
|
|
- Operation ID: `get_mapped_metrics`
|
|
- Route: `GET /api/mapped-metrics`
|
|
- Mode: READ
|
|
- Summary: Get Mapped Metrics
|
|
- Parameters:
|
|
- `fields[custom-metric]` in `query`
|
|
- `fields[mapped-metric]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_mapped_metric
|
|
|
|
- Operation ID: `get_mapped_metric`
|
|
- Route: `GET /api/mapped-metrics/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Mapped Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[custom-metric]` in `query`
|
|
- `fields[mapped-metric]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_mapped_metric
|
|
|
|
- Operation ID: `update_mapped_metric`
|
|
- Route: `PATCH /api/mapped-metrics/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Mapped Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[mapped-metric]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_metric_for_mapped_metric
|
|
|
|
- Operation ID: `get_metric_for_mapped_metric`
|
|
- Route: `GET /api/mapped-metrics/{id}/metric`
|
|
- Mode: READ
|
|
- Summary: Get Metric for Mapped Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[metric]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_metric_id_for_mapped_metric
|
|
|
|
- Operation ID: `get_metric_id_for_mapped_metric`
|
|
- Route: `GET /api/mapped-metrics/{id}/relationships/metric`
|
|
- Mode: READ
|
|
- Summary: Get Metric ID for Mapped Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_custom_metric_for_mapped_metric
|
|
|
|
- Operation ID: `get_custom_metric_for_mapped_metric`
|
|
- Route: `GET /api/mapped-metrics/{id}/custom-metric`
|
|
- Mode: READ
|
|
- Summary: Get Custom Metric for Mapped Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[custom-metric]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_custom_metric_id_for_mapped_metric
|
|
|
|
- Operation ID: `get_custom_metric_id_for_mapped_metric`
|
|
- Route: `GET /api/mapped-metrics/{id}/relationships/custom-metric`
|
|
- Mode: READ
|
|
- Summary: Get Custom Metric ID for Mapped Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|