Inspection

The inspection resource.

Basehttps://rest.carbon.ms/inspection

GET/inspection

List inspections

Retrieve a paginated list of inspections. 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/inspection

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

Response

[
  {
    "id": "abc123def456",
    "inspectionId": "xyz789",
    "itemId": "xyz789",
    "lotSize": 0,
    "samplingStandard": "string",
    "samplingPlanType": "string",
    "sampleSize": 0,
    "acceptanceNumber": 0
  }
]

GET/inspection

Retrieve a inspection

Fetch a single inspection by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/inspection

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

Response

{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "itemId": "xyz789",
  "lotSize": 0,
  "samplingStandard": "string",
  "samplingPlanType": "string",
  "sampleSize": 0,
  "acceptanceNumber": 0
}

POST/inspection

Create a inspection

Create a new inspection.

Body parameters

inspectionIdstringrequired

itemIdstringrequired

References item.id

itemReadableIdstring

supplierIdstring

lotSizenumberrequired

samplingStandardsamplingStandardrequired

samplingPlanTypesamplingPlanTyperequired

sampleSizenumberrequired

acceptanceNumbernumberrequired

rejectionNumbernumberrequired

aqlnumber

inspectionLevelinspectionLevel

severityinspectionSeverity

codeLetterstring

statusinspectionStatusTyperequired

notesstring

dispositionedBystring

References user.id

dispositionedAttimestamp

companyIdstringrequired

References company.id

inspectionDocumentIdstring

References inspectionDocument.id

sourceDocumentinspectionSourceDocumentrequired

sourceDocumentIdstringrequired

sourceDocumentLineIdstring

sourceDocumentReadableIdstring

POSThttps://rest.carbon.ms/inspection

curl --request POST \
  --url https://rest.carbon.ms/inspection \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionId":"xyz789","itemId":"xyz789","lotSize":0,"samplingStandard":"string","samplingPlanType":"string","sampleSize":0,"acceptanceNumber":0,"rejectionNumber":0,"status":"string","companyId":"xyz789","sourceDocument":"string","sourceDocumentId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "itemId": "xyz789",
  "lotSize": 0,
  "samplingStandard": "string",
  "samplingPlanType": "string",
  "sampleSize": 0,
  "acceptanceNumber": 0
}

PATCH/inspection

Update a inspection

Update an existing inspection, matched on `id`.

Body parameters

inspectionIdstringrequired

itemIdstringrequired

References item.id

itemReadableIdstring

supplierIdstring

lotSizenumberrequired

samplingStandardsamplingStandardrequired

samplingPlanTypesamplingPlanTyperequired

sampleSizenumberrequired

acceptanceNumbernumberrequired

rejectionNumbernumberrequired

aqlnumber

inspectionLevelinspectionLevel

severityinspectionSeverity

codeLetterstring

statusinspectionStatusTyperequired

notesstring

dispositionedBystring

References user.id

dispositionedAttimestamp

companyIdstringrequired

References company.id

inspectionDocumentIdstring

References inspectionDocument.id

sourceDocumentinspectionSourceDocumentrequired

sourceDocumentIdstringrequired

sourceDocumentLineIdstring

sourceDocumentReadableIdstring

PATCHhttps://rest.carbon.ms/inspection

curl --request PATCH \
  --url 'https://rest.carbon.ms/inspection?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",
  "lotSize": 0,
  "samplingStandard": "string",
  "samplingPlanType": "string",
  "sampleSize": 0,
  "acceptanceNumber": 0
}

DELETE/inspection

Delete a inspection

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/inspection

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

204 No Content