Carbon

Inspection Document

The inspection document resource.

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

List inspection documents

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

Retrieve a inspection document

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

Query parameters

idstring

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

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

Create a inspection document

Create a new inspection document.

Body parameters

partIdstringrequired

References item.id

drawingNumberstring
versionnumberrequired
storagePathstring
fileNamestring
pageCountnumber
defaultPageWidthnumber
defaultPageHeightnumber
uploadedBystring

References user.id

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

Update a inspection document

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

Body parameters

partIdstringrequired

References item.id

drawingNumberstring
versionnumberrequired
storagePathstring
fileNamestring
pageCountnumber
defaultPageWidthnumber
defaultPageHeightnumber
uploadedBystring

References user.id

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

Delete a inspection document

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

Query parameters

idstring

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

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