Carbon

Inspection Feature

The inspection feature resource.

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

List inspection features

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

Retrieve a inspection feature

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

Query parameters

idstring

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

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

Create a inspection feature

Create a new inspection feature.

Body parameters

inspectionDocumentIdstringrequired
pageNumbernumberrequired
labelstringrequired
descriptionstring
nominalValuestring
tolerancePlusstring
toleranceMinusstring
unitstring
typeprocedureStepTyperequired
POSThttps://rest.carbon.ms/inspectionFeature
curl --request POST \
  --url https://rest.carbon.ms/inspectionFeature \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionDocumentId":"xyz789","pageNumber":0,"label":"string","description":"string","type":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inspectionDocumentId": "xyz789",
  "pageNumber": 0,
  "label": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "type": "string"
}
PATCH/inspectionFeature

Update a inspection feature

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

Body parameters

inspectionDocumentIdstringrequired
pageNumbernumberrequired
labelstringrequired
descriptionstring
nominalValuestring
tolerancePlusstring
toleranceMinusstring
unitstring
typeprocedureStepTyperequired
PATCHhttps://rest.carbon.ms/inspectionFeature
curl --request PATCH \
  --url 'https://rest.carbon.ms/inspectionFeature?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"inspectionDocumentId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "inspectionDocumentId": "xyz789",
  "pageNumber": 0,
  "label": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "type": "string"
}
DELETE/inspectionFeature

Delete a inspection feature

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

Query parameters

idstring

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

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