Run saved queries
GET /api/v1/saved-queries/{savedQueryId}/run: request fields and declared response contract.
GET/api/v1/saved-queries/{savedQueryId}/run
| Permission | saved-query.read |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Parameters
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| savedQueryId | string | required | non-null | — |
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| resultMode | "rows" | "refs" | optional | non-null | — |
| size | integer | optional | non-null | — |
| targetEntityId | string | optional | non-null | — |
Response
200
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | unknown | required | non-null | — |
Declared failures
| SAVED_QUERY_RUN_FAILED | 400 — not retryable |
|---|---|
| SAVED_QUERY_SET_INVALID | 422 — not retryable |
| SAVED_QUERY_SET_OVERFLOW | 422 — not retryable |
| SAVED_QUERY_SET_PROJECTION_STALE | 503 — retryable |
| SAVED_QUERY_SET_UNAUTHORIZED | 403 — not retryable |
Readback
This method returns the current state it read.
- savedQueries.run
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
GET /api/v1/saved-queries/{savedQueryId}/run HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>