Carbon

Inspection History

The inspection history resource.

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

List inspection histories

Retrieve a paginated list of inspection histories. 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/inspectionHistory
curl --request GET \
  --url 'https://rest.carbon.ms/inspectionHistory?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "inspectionId": "xyz789",
    "itemId": "xyz789",
    "samplingStandard": "string",
    "severity": "string",
    "lotSize": 0,
    "sampleSize": 0,
    "defectsFound": 0
  }
]
GET/inspectionHistory

Retrieve a inspection history

Fetch a single inspection history by filtering on `id`.

Query parameters

idstring

Match on the inspection history's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/inspectionHistory
curl --request GET \
  --url 'https://rest.carbon.ms/inspectionHistory?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "itemId": "xyz789",
  "samplingStandard": "string",
  "severity": "string",
  "lotSize": 0,
  "sampleSize": 0,
  "defectsFound": 0
}
POST/inspectionHistory

Create a inspection history

Create a new inspection history.

Body parameters

inspectionIdstringrequired

References inspection.id

itemIdstringrequired

References item.id

supplierIdstring
samplingStandardsamplingStandardrequired
severityinspectionSeverityrequired
inspectionLevelinspectionLevel
aqlnumber
lotSizenumberrequired
sampleSizenumberrequired
defectsFoundnumberrequired
outcomestringrequired
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/inspectionHistory
curl --request POST \
  --url https://rest.carbon.ms/inspectionHistory \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionId":"xyz789","itemId":"xyz789","samplingStandard":"string","severity":"string","lotSize":0,"sampleSize":0,"defectsFound":0,"outcome":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "itemId": "xyz789",
  "samplingStandard": "string",
  "severity": "string",
  "lotSize": 0,
  "sampleSize": 0,
  "defectsFound": 0
}
PATCH/inspectionHistory

Update a inspection history

Update an existing inspection history, matched on `id`.

Body parameters

inspectionIdstringrequired

References inspection.id

itemIdstringrequired

References item.id

supplierIdstring
samplingStandardsamplingStandardrequired
severityinspectionSeverityrequired
inspectionLevelinspectionLevel
aqlnumber
lotSizenumberrequired
sampleSizenumberrequired
defectsFoundnumberrequired
outcomestringrequired
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/inspectionHistory
curl --request PATCH \
  --url 'https://rest.carbon.ms/inspectionHistory?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "itemId": "xyz789",
  "samplingStandard": "string",
  "severity": "string",
  "lotSize": 0,
  "sampleSize": 0,
  "defectsFound": 0
}
DELETE/inspectionHistory

Delete a inspection history

Delete a inspection history, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the inspection history to delete, e.g. `eq.{id}`.

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