Sign in
Dimension

Update a dimension

Updates an dimension.

patch/dimension/{id}

Path parameters

idinteger required

The ID of the dimension.

Request body

status'active' | 'inactive'
orderinteger

The priority this dimension will have whenever runtime configuration values are merged (lower prelates higher numbers)

Example request

{
  "status": "active",
  "order": 1
}

Response

The operation was successful.

idinteger

A system-wide unique ID representing the dimension.

namestring

The name of the dimension

status'active' | 'inactive'

The status of this dimension.

slugstring

A name-derived string representing the dimension.

nrnstring

NRN (at or below) where the dimension applies.

orderinteger

The priority this dimension has whenever runtime configuration values are merged (lower prelates higher numbers).

Example response

{
  "id": 1234,
  "name": "Environment",
  "status": "active",
  "slug": "environment",
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "order": 1,
  "values": {
    "id": 9876,
    "name": "Staging",
    "status": "active",
    "slug": "staging",
    "nrn": "organization=1:account=2:namespace=3:application=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.