Dimension

Read a dimension

Changed on

Read a dimension by its ID.

get/dimension/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/dimension/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The ID of the dimension.

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

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status