Carbon

Item Sampling Plan

The item sampling plan resource.

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

List item sampling plans

Retrieve a paginated list of item sampling plans. 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/itemSamplingPlan
curl --request GET \
  --url 'https://rest.carbon.ms/itemSamplingPlan?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "itemId": "xyz789",
    "type": "string",
    "inspectionLevel": "string",
    "severity": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "sampleSize": 0
  }
]
GET/itemSamplingPlan

Retrieve a item sampling plan

Fetch a single item sampling plan by filtering on `itemId`.

Query parameters

itemIdstring

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

GEThttps://rest.carbon.ms/itemSamplingPlan
curl --request GET \
  --url 'https://rest.carbon.ms/itemSamplingPlan?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "itemId": "xyz789",
  "type": "string",
  "inspectionLevel": "string",
  "severity": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "sampleSize": 0
}
POST/itemSamplingPlan

Create a item sampling plan

Create a new item sampling plan.

Body parameters

typesamplingPlanTyperequired
sampleSizenumber
percentagenumber
aqlnumber
inspectionLevelinspectionLevelrequired
severityinspectionSeverityrequired
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/itemSamplingPlan
curl --request POST \
  --url https://rest.carbon.ms/itemSamplingPlan \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"type":"string","inspectionLevel":"string","severity":"string","companyId":"xyz789"}'
Response
{
  "itemId": "xyz789",
  "type": "string",
  "inspectionLevel": "string",
  "severity": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "sampleSize": 0
}
PATCH/itemSamplingPlan

Update a item sampling plan

Update an existing item sampling plan, matched on `itemId`.

Body parameters

typesamplingPlanTyperequired
sampleSizenumber
percentagenumber
aqlnumber
inspectionLevelinspectionLevelrequired
severityinspectionSeverityrequired
companyIdstringrequired

References company.id

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

Delete a item sampling plan

Delete a item sampling plan, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

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

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