Carbon

Inspection Sample

The inspection sample resource.

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

List inspection samples

Retrieve a paginated list of inspection samples. 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/inspectionSample
curl --request GET \
  --url 'https://rest.carbon.ms/inspectionSample?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "inspectionId": "xyz789",
    "status": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "trackedEntityId": "xyz789",
    "notes": "string"
  }
]
GET/inspectionSample

Retrieve a inspection sample

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/inspectionSample
curl --request GET \
  --url 'https://rest.carbon.ms/inspectionSample?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "trackedEntityId": "xyz789",
  "notes": "string"
}
POST/inspectionSample

Create a inspection sample

Create a new inspection sample.

Body parameters

inspectionIdstringrequired

References inspection.id

trackedEntityIdstring

References trackedEntity.id

statusinspectionSampleStatusTyperequired
notesstring
inspectedBystring

References user.id

inspectedAttimestamp
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/inspectionSample
curl --request POST \
  --url https://rest.carbon.ms/inspectionSample \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionId":"xyz789","status":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "inspectionId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "trackedEntityId": "xyz789",
  "notes": "string"
}
PATCH/inspectionSample

Update a inspection sample

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

Body parameters

inspectionIdstringrequired

References inspection.id

trackedEntityIdstring

References trackedEntity.id

statusinspectionSampleStatusTyperequired
notesstring
inspectedBystring

References user.id

inspectedAttimestamp
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/inspectionSample
curl --request PATCH \
  --url 'https://rest.carbon.ms/inspectionSample?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",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "trackedEntityId": "xyz789",
  "notes": "string"
}
DELETE/inspectionSample

Delete a inspection sample

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

Query parameters

idstring

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

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