Dimensions
Tags such as location, department, job, event and provider.
GET /dimensionsList dimensionsPOST /dimensionsCreate a dimensionPATCH /dimensions/{dimension_code}Rename a dimensionPATCH /dimensions/{dimension_code}/values/{value_code}Rename or retire a valuePOST /dimensions/{dimension_code}/valuesAdd a dimension value
List dimensions
GET /dimensions
Sends Vortex-Entity.
Answers
Create a dimension
POST /dimensions
Sends Vortex-Entity and Idempotency-Key.
Requires accounts:write.
Body
| Field | Type | About |
|---|---|---|
code required | Code | |
name required | string | Up to 100 characters. |
Answers
Rename a dimension
PATCH /dimensions/{dimension_code}
Sends Vortex-Entity.
Requires accounts:write.
Parameters
| Name | In | Type | About |
|---|---|---|---|
dimension_code required | path | Code |
Body
| Field | Type | About |
|---|---|---|
name required | string | Up to 100 characters. |
Answers
Rename or retire a value
PATCH /dimensions/{dimension_code}/values/{value_code}
Sends Vortex-Entity.
Lines keep their codes, so a value is never removed. A retired value stays on reports and stops being offered for new entries. Requires accounts:write.
Parameters
| Name | In | Type | About |
|---|---|---|---|
dimension_code required | path | Code | |
value_code required | path | string |
Body
| Field | Type | About |
|---|---|---|
name | string | Up to 100 characters. |
is_active | boolean |
Answers
- 200 DimensionValue. The value.
- 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
- 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
Add a dimension value
POST /dimensions/{dimension_code}/values
Sends Vortex-Entity and Idempotency-Key.
Adds a value such as a new location. A posted line also adds any dimension or value it uses, with a readable name to change later. Requires accounts:write.
Parameters
| Name | In | Type | About |
|---|---|---|---|
dimension_code required | path | Code |
Body
| Field | Type | About |
|---|---|---|
code required | Code | |
name required | string | Up to 100 characters. |
Answers
- 201 DimensionValue. The value.
- 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
- 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

