Dimension Value

The dimension value resource.

Basehttps://rest.carbon.ms/dimensionValue

GET/dimensionValue

List dimension values

Retrieve a paginated list of dimension values. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/dimensionValue

curl --request GET \
  --url 'https://rest.carbon.ms/dimensionValue?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "dimensionId": "xyz789",
    "name": "Example",
    "companyGroupId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/dimensionValue

Retrieve a dimension value

Fetch a single dimension value by filtering on `id`.

Query parameters

idstring

Match on the dimension value's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/dimensionValue

curl --request GET \
  --url 'https://rest.carbon.ms/dimensionValue?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "dimensionId": "xyz789",
  "name": "Example",
  "companyGroupId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/dimensionValue

Create a dimension value

Create a new dimension value.

Body parameters

dimensionIdstringrequired

References dimension.id

namestringrequired

companyGroupIdstringrequired

References companyGroup.id

POSThttps://rest.carbon.ms/dimensionValue

curl --request POST \
  --url https://rest.carbon.ms/dimensionValue \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"dimensionId":"xyz789","name":"Example","companyGroupId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "dimensionId": "xyz789",
  "name": "Example",
  "companyGroupId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/dimensionValue

Update a dimension value

Update an existing dimension value, matched on `id`.

Body parameters

dimensionIdstringrequired

References dimension.id

namestringrequired

companyGroupIdstringrequired

References companyGroup.id

PATCHhttps://rest.carbon.ms/dimensionValue

curl --request PATCH \
  --url 'https://rest.carbon.ms/dimensionValue?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"dimensionId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "dimensionId": "xyz789",
  "name": "Example",
  "companyGroupId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/dimensionValue

Delete a dimension value

Delete a dimension value, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the dimension value to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/dimensionValue

curl --request DELETE \
  --url 'https://rest.carbon.ms/dimensionValue?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content