Declare groupings
POST /api/v1/groupings: request fields and declared response contract.
POST/api/v1/groupings
| Permission | settings.manage |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| axis | string | required | non-null | — |
| label | string | optional | non-null | — |
| parentAxis | string | optional | non-null | — |
| values | array | optional | non-null | — |
Response
201
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.success | boolean | required | non-null | — |
| data.axisId | string | required | non-null | — |
| data.axis | string | required | non-null | — |
| data.valuesUpserted | number | required | non-null | — |
Declared failures
| GROUPING_DECLARE_FAILED | 400 — not retryable |
|---|
Readback
Read the result back with:
- grouping.list
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
POST /api/v1/groupings HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"axis": "<axis>"
}