Carbon

Configuration Rule

The configuration rule resource.

Basehttps://rest.carbon.ms/configurationRule
GET/configurationRule

List configuration rules

Retrieve a paginated list of configuration rules. 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/configurationRule
curl --request GET \
  --url 'https://rest.carbon.ms/configurationRule?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "itemId": "xyz789",
    "field": "string",
    "code": "string",
    "companyId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string"
  }
]
GET/configurationRule

Retrieve a configuration rule

Fetch a single configuration rule by filtering on `itemId`.

Query parameters

itemIdstring

Match on the configuration rule's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/configurationRule
curl --request GET \
  --url 'https://rest.carbon.ms/configurationRule?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "itemId": "xyz789",
  "field": "string",
  "code": "string",
  "companyId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
POST/configurationRule

Create a configuration rule

Create a new configuration rule.

Body parameters

codestringrequired
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/configurationRule
curl --request POST \
  --url https://rest.carbon.ms/configurationRule \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"code":"string","companyId":"xyz789"}'
Response
{
  "itemId": "xyz789",
  "field": "string",
  "code": "string",
  "companyId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
PATCH/configurationRule

Update a configuration rule

Update an existing configuration rule, matched on `itemId`.

Body parameters

codestringrequired
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/configurationRule
curl --request PATCH \
  --url 'https://rest.carbon.ms/configurationRule?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"code":"string"}'
Response
{
  "itemId": "xyz789",
  "field": "string",
  "code": "string",
  "companyId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
DELETE/configurationRule

Delete a configuration rule

Delete a configuration rule, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the configuration rule to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/configurationRule
curl --request DELETE \
  --url 'https://rest.carbon.ms/configurationRule?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content