Item Rule Assignment

The item rule assignment resource.

Basehttps://rest.carbon.ms/itemRuleAssignment

GET/itemRuleAssignment

List item rule assignments

Retrieve a paginated list of item rule assignments. 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/itemRuleAssignment

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

Response

[
  {
    "itemId": "xyz789",
    "ruleId": "xyz789",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/itemRuleAssignment

Retrieve a item rule assignment

Fetch a single item rule assignment by filtering on `itemId`.

Query parameters

itemIdstring

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

GEThttps://rest.carbon.ms/itemRuleAssignment

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

Response

{
  "itemId": "xyz789",
  "ruleId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/itemRuleAssignment

Create a item rule assignment

Create a new item rule assignment.

Body parameters

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/itemRuleAssignment

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

Response

{
  "itemId": "xyz789",
  "ruleId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/itemRuleAssignment

Update a item rule assignment

Update an existing item rule assignment, matched on `itemId`.

Body parameters

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/itemRuleAssignment

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

Response

{
  "itemId": "xyz789",
  "ruleId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/itemRuleAssignment

Delete a item rule assignment

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

Query parameters

itemIdstring

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

DELETEhttps://rest.carbon.ms/itemRuleAssignment

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

204 No Content