Carbon

Item Rule

The item rule resource.

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

List item rules

Retrieve a paginated list of item 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/itemRule
curl --request GET \
  --url 'https://rest.carbon.ms/itemRule?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "message": "string",
    "severity": "string",
    "conditionAst": "string",
    "surfaces": [],
    "active": true
  }
]
GET/itemRule

Retrieve a item rule

Fetch a single item rule by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/itemRule
curl --request GET \
  --url 'https://rest.carbon.ms/itemRule?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "message": "string",
  "severity": "string",
  "conditionAst": "string",
  "surfaces": [],
  "active": true
}
POST/itemRule

Create a item rule

Create a new item rule.

Body parameters

companyIdstringrequired

References company.id

namestringrequired
descriptionstring
messagestringrequired
severitystringrequired
conditionAstobjectrequired
surfacestransactionSurfacerequired
activebooleanrequired
customFieldsobject
POSThttps://rest.carbon.ms/itemRule
curl --request POST \
  --url https://rest.carbon.ms/itemRule \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","name":"Example","description":"string","message":"string","severity":"string","conditionAst":"string","surfaces":[],"active":true}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "message": "string",
  "severity": "string",
  "conditionAst": "string",
  "surfaces": [],
  "active": true
}
PATCH/itemRule

Update a item rule

Update an existing item rule, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

namestringrequired
descriptionstring
messagestringrequired
severitystringrequired
conditionAstobjectrequired
surfacestransactionSurfacerequired
activebooleanrequired
customFieldsobject
PATCHhttps://rest.carbon.ms/itemRule
curl --request PATCH \
  --url 'https://rest.carbon.ms/itemRule?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "message": "string",
  "severity": "string",
  "conditionAst": "string",
  "surfaces": [],
  "active": true
}
DELETE/itemRule

Delete a item rule

Delete a item rule, matched on `id`. Returns 204 No Content.

Query parameters

idstring

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

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