Dimensions

Tags such as location, department, job, event and provider.

List dimensions

GET /dimensions

Sends Vortex-Entity.

Answers

  • 200 object. All dimensions with their values.
  • 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

Create a dimension

POST /dimensions

Sends Vortex-Entity and Idempotency-Key.

Requires accounts:write.

Body

FieldTypeAbout
code requiredCode
name requiredstring

Up to 100 characters.

Answers

  • 201 Dimension. The dimension.
  • 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

Rename a dimension

PATCH /dimensions/{dimension_code}

Sends Vortex-Entity.

Requires accounts:write.

Parameters

NameInTypeAbout
dimension_code requiredpathCode

Body

FieldTypeAbout
name requiredstring

Up to 100 characters.

Answers

  • 200 Dimension. The dimension.
  • 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

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

NameInTypeAbout
dimension_code requiredpathCode
value_code requiredpathstring

Body

FieldTypeAbout
namestring

Up to 100 characters.

is_activeboolean

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

NameInTypeAbout
dimension_code requiredpathCode

Body

FieldTypeAbout
code requiredCode
name requiredstring

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